@easyedu/js-lsm-api 1.96.0 → 1.98.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 (151) hide show
  1. package/.openapi-generator/FILES +14 -14
  2. package/README.md +18 -19
  3. package/dist/apis/CourseApi.d.ts +69 -87
  4. package/dist/apis/CourseApi.js +115 -164
  5. package/dist/apis/ReportingApi.d.ts +16 -16
  6. package/dist/apis/ReportingApi.js +29 -29
  7. package/dist/esm/apis/CourseApi.d.ts +69 -87
  8. package/dist/esm/apis/CourseApi.js +115 -164
  9. package/dist/esm/apis/ReportingApi.d.ts +16 -16
  10. package/dist/esm/apis/ReportingApi.js +29 -29
  11. package/dist/esm/models/GetCourseEnrollment.d.ts +12 -0
  12. package/dist/esm/models/GetCourseEnrollment.js +8 -0
  13. package/dist/esm/models/GetCourseEnrollmentListItem.d.ts +12 -0
  14. package/dist/esm/models/GetCourseEnrollmentListItem.js +8 -0
  15. package/dist/esm/models/GetCourseExport.d.ts +2 -2
  16. package/dist/esm/models/GetCourseExport.js +3 -3
  17. package/dist/esm/models/GetCourseVersion.d.ts +3 -3
  18. package/dist/esm/models/GetCourseVersion.js +4 -4
  19. package/dist/esm/models/GetCourseVersionReporting.d.ts +3 -3
  20. package/dist/esm/models/GetCourseVersionReporting.js +4 -4
  21. package/dist/esm/models/GetCourseVersionSection.d.ts +64 -0
  22. package/dist/esm/models/{GetCourseVersionModule.js → GetCourseVersionSection.js} +12 -12
  23. package/dist/esm/models/GetCourseVersionSectionChild.d.ts +54 -0
  24. package/dist/esm/models/GetCourseVersionSectionChild.js +56 -0
  25. package/dist/esm/models/GetCourseVersionSectionReporting.d.ts +99 -0
  26. package/dist/esm/models/{GetCourseVersionModuleReporting.js → GetCourseVersionSectionReporting.js} +11 -11
  27. package/dist/esm/models/GetPermission.d.ts +1 -1
  28. package/dist/esm/models/PostCourseExport.d.ts +2 -2
  29. package/dist/esm/models/PostCourseExport.js +3 -3
  30. package/dist/esm/models/PostCourseResume.d.ts +1 -1
  31. package/dist/esm/models/PostCourseResume.js +3 -3
  32. package/dist/esm/models/PostCourseVersionPublish.d.ts +10 -0
  33. package/dist/esm/models/PostCourseVersionPublish.js +2 -0
  34. package/dist/esm/models/PostCourseVersionSection.d.ts +57 -0
  35. package/dist/esm/models/{PostCourseVersionModule.js → PostCourseVersionSection.js} +10 -8
  36. package/dist/esm/models/PostCourseVersionSectionDuplicate.d.ts +44 -0
  37. package/dist/esm/models/PostCourseVersionSectionDuplicate.js +45 -0
  38. package/dist/esm/models/PutCourseEnrollment.d.ts +9 -0
  39. package/dist/esm/models/PutCourseEnrollment.js +2 -0
  40. package/dist/esm/models/PutCourseVersionItem.d.ts +1 -1
  41. package/dist/esm/models/PutCourseVersionItem.js +2 -2
  42. package/dist/esm/models/PutCourseVersionOutlineEntryMove.d.ts +58 -0
  43. package/dist/esm/models/PutCourseVersionOutlineEntryMove.js +60 -0
  44. package/dist/esm/models/PutCourseVersionSection.d.ts +45 -0
  45. package/dist/esm/models/{PutCourseVersionModule.js → PutCourseVersionSection.js} +8 -10
  46. package/dist/esm/models/PutRolePermissions.d.ts +1 -1
  47. package/dist/esm/models/index.d.ts +7 -7
  48. package/dist/esm/models/index.js +7 -7
  49. package/dist/models/GetCourseEnrollment.d.ts +12 -0
  50. package/dist/models/GetCourseEnrollment.js +8 -0
  51. package/dist/models/GetCourseEnrollmentListItem.d.ts +12 -0
  52. package/dist/models/GetCourseEnrollmentListItem.js +8 -0
  53. package/dist/models/GetCourseExport.d.ts +2 -2
  54. package/dist/models/GetCourseExport.js +3 -3
  55. package/dist/models/GetCourseVersion.d.ts +3 -3
  56. package/dist/models/GetCourseVersion.js +4 -4
  57. package/dist/models/GetCourseVersionReporting.d.ts +3 -3
  58. package/dist/models/GetCourseVersionReporting.js +4 -4
  59. package/dist/models/GetCourseVersionSection.d.ts +64 -0
  60. package/dist/models/{GetCourseVersionModule.js → GetCourseVersionSection.js} +17 -17
  61. package/dist/models/GetCourseVersionSectionChild.d.ts +54 -0
  62. package/dist/models/GetCourseVersionSectionChild.js +64 -0
  63. package/dist/models/GetCourseVersionSectionReporting.d.ts +99 -0
  64. package/dist/models/{GetCourseVersionModuleReporting.js → GetCourseVersionSectionReporting.js} +16 -16
  65. package/dist/models/GetPermission.d.ts +1 -1
  66. package/dist/models/PostCourseExport.d.ts +2 -2
  67. package/dist/models/PostCourseExport.js +3 -3
  68. package/dist/models/PostCourseResume.d.ts +1 -1
  69. package/dist/models/PostCourseResume.js +3 -3
  70. package/dist/models/PostCourseVersionPublish.d.ts +10 -0
  71. package/dist/models/PostCourseVersionPublish.js +2 -0
  72. package/dist/models/PostCourseVersionSection.d.ts +57 -0
  73. package/dist/models/{PostCourseVersionModule.js → PostCourseVersionSection.js} +15 -13
  74. package/dist/models/PostCourseVersionSectionDuplicate.d.ts +44 -0
  75. package/dist/models/PostCourseVersionSectionDuplicate.js +52 -0
  76. package/dist/models/PutCourseEnrollment.d.ts +9 -0
  77. package/dist/models/PutCourseEnrollment.js +2 -0
  78. package/dist/models/PutCourseVersionItem.d.ts +1 -1
  79. package/dist/models/PutCourseVersionItem.js +2 -2
  80. package/dist/models/PutCourseVersionOutlineEntryMove.d.ts +58 -0
  81. package/dist/models/PutCourseVersionOutlineEntryMove.js +68 -0
  82. package/dist/models/PutCourseVersionSection.d.ts +45 -0
  83. package/dist/models/{PutCourseVersionModule.js → PutCourseVersionSection.js} +13 -15
  84. package/dist/models/PutRolePermissions.d.ts +1 -1
  85. package/dist/models/index.d.ts +7 -7
  86. package/dist/models/index.js +7 -7
  87. package/docs/CourseApi.md +94 -166
  88. package/docs/GetCourseEnrollment.md +4 -0
  89. package/docs/GetCourseEnrollmentListItem.md +4 -0
  90. package/docs/GetCourseExport.md +2 -2
  91. package/docs/GetCourseVersion.md +2 -2
  92. package/docs/GetCourseVersionReporting.md +2 -2
  93. package/docs/{GetCourseVersionModule.md → GetCourseVersionSection.md} +6 -6
  94. package/docs/{PutCourseVersionItemReorder.md → GetCourseVersionSectionChild.md} +11 -6
  95. package/docs/{GetCourseVersionModuleReporting.md → GetCourseVersionSectionReporting.md} +6 -6
  96. package/docs/PostCourseExport.md +2 -2
  97. package/docs/PostCourseResume.md +2 -2
  98. package/docs/PostCourseVersionPublish.md +2 -0
  99. package/docs/{PostCourseVersionModule.md → PostCourseVersionSection.md} +6 -4
  100. package/docs/{PostCourseVersionModuleDuplicate.md → PostCourseVersionSectionDuplicate.md} +6 -4
  101. package/docs/PutCourseEnrollment.md +2 -0
  102. package/docs/PutCourseVersionItem.md +2 -2
  103. package/docs/{PutCourseVersionModuleReorder.md → PutCourseVersionOutlineEntryMove.md} +12 -6
  104. package/docs/{PutCourseVersionModule.md → PutCourseVersionSection.md} +4 -6
  105. package/docs/ReportingApi.md +22 -22
  106. package/package.json +1 -1
  107. package/src/apis/CourseApi.ts +160 -234
  108. package/src/apis/ReportingApi.ts +40 -40
  109. package/src/models/GetCourseEnrollment.ts +18 -0
  110. package/src/models/GetCourseEnrollmentListItem.ts +18 -0
  111. package/src/models/GetCourseExport.ts +5 -5
  112. package/src/models/GetCourseVersion.ts +12 -12
  113. package/src/models/GetCourseVersionReporting.ts +11 -11
  114. package/src/models/{GetCourseVersionModule.ts → GetCourseVersionSection.ts} +28 -28
  115. package/src/models/GetCourseVersionSectionChild.ts +108 -0
  116. package/src/models/{GetCourseVersionModuleReporting.ts → GetCourseVersionSectionReporting.ts} +26 -26
  117. package/src/models/GetPermission.ts +1 -1
  118. package/src/models/PostCourseExport.ts +5 -5
  119. package/src/models/PostCourseResume.ts +4 -4
  120. package/src/models/PostCourseVersionPublish.ts +12 -0
  121. package/src/models/{PostCourseVersionModule.ts → PostCourseVersionSection.ts} +22 -14
  122. package/src/models/PostCourseVersionSectionDuplicate.ts +81 -0
  123. package/src/models/PutCourseEnrollment.ts +11 -0
  124. package/src/models/PutCourseVersionItem.ts +3 -3
  125. package/src/models/PutCourseVersionOutlineEntryMove.ts +103 -0
  126. package/src/models/{PutCourseVersionModule.ts → PutCourseVersionSection.ts} +13 -21
  127. package/src/models/PutRolePermissions.ts +1 -1
  128. package/src/models/index.ts +7 -7
  129. package/dist/esm/models/GetCourseVersionModule.d.ts +0 -64
  130. package/dist/esm/models/GetCourseVersionModuleReporting.d.ts +0 -99
  131. package/dist/esm/models/PostCourseVersionModule.d.ts +0 -51
  132. package/dist/esm/models/PostCourseVersionModuleDuplicate.d.ts +0 -38
  133. package/dist/esm/models/PostCourseVersionModuleDuplicate.js +0 -43
  134. package/dist/esm/models/PutCourseVersionItemReorder.d.ts +0 -32
  135. package/dist/esm/models/PutCourseVersionItemReorder.js +0 -43
  136. package/dist/esm/models/PutCourseVersionModule.d.ts +0 -51
  137. package/dist/esm/models/PutCourseVersionModuleReorder.d.ts +0 -32
  138. package/dist/esm/models/PutCourseVersionModuleReorder.js +0 -43
  139. package/dist/models/GetCourseVersionModule.d.ts +0 -64
  140. package/dist/models/GetCourseVersionModuleReporting.d.ts +0 -99
  141. package/dist/models/PostCourseVersionModule.d.ts +0 -51
  142. package/dist/models/PostCourseVersionModuleDuplicate.d.ts +0 -38
  143. package/dist/models/PostCourseVersionModuleDuplicate.js +0 -50
  144. package/dist/models/PutCourseVersionItemReorder.d.ts +0 -32
  145. package/dist/models/PutCourseVersionItemReorder.js +0 -50
  146. package/dist/models/PutCourseVersionModule.d.ts +0 -51
  147. package/dist/models/PutCourseVersionModuleReorder.d.ts +0 -32
  148. package/dist/models/PutCourseVersionModuleReorder.js +0 -50
  149. package/src/models/PostCourseVersionModuleDuplicate.ts +0 -73
  150. package/src/models/PutCourseVersionItemReorder.ts +0 -66
  151. package/src/models/PutCourseVersionModuleReorder.ts +0 -66
@@ -13,26 +13,26 @@
13
13
  */
14
14
 
15
15
  import * as runtime from '../runtime';
16
- import {
17
- type GetCourseVersionModuleReporting,
18
- GetCourseVersionModuleReportingFromJSON,
19
- GetCourseVersionModuleReportingToJSON,
20
- } from '../models/GetCourseVersionModuleReporting';
21
16
  import {
22
17
  type GetCourseVersionReporting,
23
18
  GetCourseVersionReportingFromJSON,
24
19
  GetCourseVersionReportingToJSON,
25
20
  } from '../models/GetCourseVersionReporting';
21
+ import {
22
+ type GetCourseVersionSectionReporting,
23
+ GetCourseVersionSectionReportingFromJSON,
24
+ GetCourseVersionSectionReportingToJSON,
25
+ } from '../models/GetCourseVersionSectionReporting';
26
26
 
27
- export interface GetCourseVersionModuleReportingRequest {
27
+ export interface GetCourseVersionReportingRequest {
28
28
  courseId: string;
29
29
  courseVersionId: string;
30
- moduleId: string;
31
30
  }
32
31
 
33
- export interface GetCourseVersionReportingRequest {
32
+ export interface GetCourseVersionSectionReportingRequest {
34
33
  courseId: string;
35
34
  courseVersionId: string;
35
+ sectionId: string;
36
36
  }
37
37
 
38
38
  /**
@@ -41,27 +41,20 @@ export interface GetCourseVersionReportingRequest {
41
41
  export class ReportingApi extends runtime.BaseAPI {
42
42
 
43
43
  /**
44
- * Creates request options for getCourseVersionModuleReporting without sending the request
44
+ * Creates request options for getCourseVersionReporting without sending the request
45
45
  */
46
- async getCourseVersionModuleReportingRequestOpts(requestParameters: GetCourseVersionModuleReportingRequest): Promise<runtime.RequestOpts> {
46
+ async getCourseVersionReportingRequestOpts(requestParameters: GetCourseVersionReportingRequest): Promise<runtime.RequestOpts> {
47
47
  if (requestParameters['courseId'] == null) {
48
48
  throw new runtime.RequiredError(
49
49
  'courseId',
50
- 'Required parameter "courseId" was null or undefined when calling getCourseVersionModuleReporting().'
50
+ 'Required parameter "courseId" was null or undefined when calling getCourseVersionReporting().'
51
51
  );
52
52
  }
53
53
 
54
54
  if (requestParameters['courseVersionId'] == null) {
55
55
  throw new runtime.RequiredError(
56
56
  'courseVersionId',
57
- 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionModuleReporting().'
58
- );
59
- }
60
-
61
- if (requestParameters['moduleId'] == null) {
62
- throw new runtime.RequiredError(
63
- 'moduleId',
64
- 'Required parameter "moduleId" was null or undefined when calling getCourseVersionModuleReporting().'
57
+ 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionReporting().'
65
58
  );
66
59
  }
67
60
 
@@ -70,10 +63,9 @@ export class ReportingApi extends runtime.BaseAPI {
70
63
  const headerParameters: runtime.HTTPHeaders = {};
71
64
 
72
65
 
73
- let urlPath = `/courses/{courseId}/versions/{courseVersionId}/modules/{moduleId}/reporting`;
66
+ let urlPath = `/courses/{courseId}/versions/{courseVersionId}/reporting`;
74
67
  urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
75
68
  urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
76
- urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
77
69
 
78
70
  return {
79
71
  path: urlPath,
@@ -84,38 +76,45 @@ export class ReportingApi extends runtime.BaseAPI {
84
76
  }
85
77
 
86
78
  /**
87
- * Get instructor reporting for one module in an explicit course version
79
+ * Get instructor reporting for one explicit course version
88
80
  */
89
- async getCourseVersionModuleReportingRaw(requestParameters: GetCourseVersionModuleReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersionModuleReporting>> {
90
- const requestOptions = await this.getCourseVersionModuleReportingRequestOpts(requestParameters);
81
+ async getCourseVersionReportingRaw(requestParameters: GetCourseVersionReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersionReporting>> {
82
+ const requestOptions = await this.getCourseVersionReportingRequestOpts(requestParameters);
91
83
  const response = await this.request(requestOptions, initOverrides);
92
84
 
93
- return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseVersionModuleReportingFromJSON(jsonValue));
85
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseVersionReportingFromJSON(jsonValue));
94
86
  }
95
87
 
96
88
  /**
97
- * Get instructor reporting for one module in an explicit course version
89
+ * Get instructor reporting for one explicit course version
98
90
  */
99
- async getCourseVersionModuleReporting(requestParameters: GetCourseVersionModuleReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionModuleReporting> {
100
- const response = await this.getCourseVersionModuleReportingRaw(requestParameters, initOverrides);
91
+ async getCourseVersionReporting(requestParameters: GetCourseVersionReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionReporting> {
92
+ const response = await this.getCourseVersionReportingRaw(requestParameters, initOverrides);
101
93
  return await response.value();
102
94
  }
103
95
 
104
96
  /**
105
- * Creates request options for getCourseVersionReporting without sending the request
97
+ * Creates request options for getCourseVersionSectionReporting without sending the request
106
98
  */
107
- async getCourseVersionReportingRequestOpts(requestParameters: GetCourseVersionReportingRequest): Promise<runtime.RequestOpts> {
99
+ async getCourseVersionSectionReportingRequestOpts(requestParameters: GetCourseVersionSectionReportingRequest): Promise<runtime.RequestOpts> {
108
100
  if (requestParameters['courseId'] == null) {
109
101
  throw new runtime.RequiredError(
110
102
  'courseId',
111
- 'Required parameter "courseId" was null or undefined when calling getCourseVersionReporting().'
103
+ 'Required parameter "courseId" was null or undefined when calling getCourseVersionSectionReporting().'
112
104
  );
113
105
  }
114
106
 
115
107
  if (requestParameters['courseVersionId'] == null) {
116
108
  throw new runtime.RequiredError(
117
109
  'courseVersionId',
118
- 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionReporting().'
110
+ 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionSectionReporting().'
111
+ );
112
+ }
113
+
114
+ if (requestParameters['sectionId'] == null) {
115
+ throw new runtime.RequiredError(
116
+ 'sectionId',
117
+ 'Required parameter "sectionId" was null or undefined when calling getCourseVersionSectionReporting().'
119
118
  );
120
119
  }
121
120
 
@@ -124,9 +123,10 @@ export class ReportingApi extends runtime.BaseAPI {
124
123
  const headerParameters: runtime.HTTPHeaders = {};
125
124
 
126
125
 
127
- let urlPath = `/courses/{courseId}/versions/{courseVersionId}/reporting`;
126
+ let urlPath = `/courses/{courseId}/versions/{courseVersionId}/sections/{sectionId}/reporting`;
128
127
  urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
129
128
  urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
129
+ urlPath = urlPath.replace('{sectionId}', encodeURIComponent(String(requestParameters['sectionId'])));
130
130
 
131
131
  return {
132
132
  path: urlPath,
@@ -137,20 +137,20 @@ export class ReportingApi extends runtime.BaseAPI {
137
137
  }
138
138
 
139
139
  /**
140
- * Get instructor reporting for one explicit course version
140
+ * Get instructor reporting for one section and its descendants in an explicit course version
141
141
  */
142
- async getCourseVersionReportingRaw(requestParameters: GetCourseVersionReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersionReporting>> {
143
- const requestOptions = await this.getCourseVersionReportingRequestOpts(requestParameters);
142
+ async getCourseVersionSectionReportingRaw(requestParameters: GetCourseVersionSectionReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersionSectionReporting>> {
143
+ const requestOptions = await this.getCourseVersionSectionReportingRequestOpts(requestParameters);
144
144
  const response = await this.request(requestOptions, initOverrides);
145
145
 
146
- return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseVersionReportingFromJSON(jsonValue));
146
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseVersionSectionReportingFromJSON(jsonValue));
147
147
  }
148
148
 
149
149
  /**
150
- * Get instructor reporting for one explicit course version
150
+ * Get instructor reporting for one section and its descendants in an explicit course version
151
151
  */
152
- async getCourseVersionReporting(requestParameters: GetCourseVersionReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionReporting> {
153
- const response = await this.getCourseVersionReportingRaw(requestParameters, initOverrides);
152
+ async getCourseVersionSectionReporting(requestParameters: GetCourseVersionSectionReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionSectionReporting> {
153
+ const response = await this.getCourseVersionSectionReportingRaw(requestParameters, initOverrides);
154
154
  return await response.value();
155
155
  }
156
156
 
@@ -37,6 +37,18 @@ export interface GetCourseEnrollment {
37
37
  * @memberof GetCourseEnrollment
38
38
  */
39
39
  userId: string;
40
+ /**
41
+ * The published course version assigned to this enrollment. Null for unpinned instructor enrollments.
42
+ * @type {string}
43
+ * @memberof GetCourseEnrollment
44
+ */
45
+ courseVersionId: string | null;
46
+ /**
47
+ * The display number of the assigned course version. Null for unpinned instructor enrollments.
48
+ * @type {number}
49
+ * @memberof GetCourseEnrollment
50
+ */
51
+ courseVersionNumber: number | null;
40
52
  /**
41
53
  * Start date of the enrollment (Unix timestamp)
42
54
  * @type {number}
@@ -146,6 +158,8 @@ export function instanceOfGetCourseEnrollment(value: object): value is GetCourse
146
158
  if (!('id' in value) || value['id'] === undefined) return false;
147
159
  if (!('courseId' in value) || value['courseId'] === undefined) return false;
148
160
  if (!('userId' in value) || value['userId'] === undefined) return false;
161
+ if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
162
+ if (!('courseVersionNumber' in value) || value['courseVersionNumber'] === undefined) return false;
149
163
  if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined) return false;
150
164
  if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined) return false;
151
165
  if (!('notes' in value) || value['notes'] === undefined) return false;
@@ -170,6 +184,8 @@ export function GetCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator:
170
184
  'id': json['id'],
171
185
  'courseId': json['course_id'],
172
186
  'userId': json['user_id'],
187
+ 'courseVersionId': json['course_version_id'],
188
+ 'courseVersionNumber': json['course_version_number'],
173
189
  'enrollmentDateStart': json['enrollment_date_start'],
174
190
  'enrollmentDateEnd': json['enrollment_date_end'],
175
191
  'notes': json['notes'],
@@ -195,6 +211,8 @@ export function GetCourseEnrollmentToJSONTyped(value?: GetCourseEnrollment | nul
195
211
  'id': value['id'],
196
212
  'course_id': value['courseId'],
197
213
  'user_id': value['userId'],
214
+ 'course_version_id': value['courseVersionId'],
215
+ 'course_version_number': value['courseVersionNumber'],
198
216
  'enrollment_date_start': value['enrollmentDateStart'],
199
217
  'enrollment_date_end': value['enrollmentDateEnd'],
200
218
  'notes': value['notes'],
@@ -37,6 +37,18 @@ export interface GetCourseEnrollmentListItem {
37
37
  * @memberof GetCourseEnrollmentListItem
38
38
  */
39
39
  userId: string;
40
+ /**
41
+ * The published course version assigned to this enrollment. Null for unpinned instructor enrollments.
42
+ * @type {string}
43
+ * @memberof GetCourseEnrollmentListItem
44
+ */
45
+ courseVersionId: string | null;
46
+ /**
47
+ * The display number of the assigned course version. Null for unpinned instructor enrollments.
48
+ * @type {number}
49
+ * @memberof GetCourseEnrollmentListItem
50
+ */
51
+ courseVersionNumber: number | null;
40
52
  /**
41
53
  * The first name of the enrolled user
42
54
  * @type {string}
@@ -142,6 +154,8 @@ export function instanceOfGetCourseEnrollmentListItem(value: object): value is G
142
154
  if (!('id' in value) || value['id'] === undefined) return false;
143
155
  if (!('courseId' in value) || value['courseId'] === undefined) return false;
144
156
  if (!('userId' in value) || value['userId'] === undefined) return false;
157
+ if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
158
+ if (!('courseVersionNumber' in value) || value['courseVersionNumber'] === undefined) return false;
145
159
  if (!('firstName' in value) || value['firstName'] === undefined) return false;
146
160
  if (!('lastName' in value) || value['lastName'] === undefined) return false;
147
161
  if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined) return false;
@@ -167,6 +181,8 @@ export function GetCourseEnrollmentListItemFromJSONTyped(json: any, ignoreDiscri
167
181
  'id': json['id'],
168
182
  'courseId': json['course_id'],
169
183
  'userId': json['user_id'],
184
+ 'courseVersionId': json['course_version_id'],
185
+ 'courseVersionNumber': json['course_version_number'],
170
186
  'firstName': json['first_name'],
171
187
  'lastName': json['last_name'],
172
188
  'enrollmentDateStart': json['enrollment_date_start'],
@@ -193,6 +209,8 @@ export function GetCourseEnrollmentListItemToJSONTyped(value?: GetCourseEnrollme
193
209
  'id': value['id'],
194
210
  'course_id': value['courseId'],
195
211
  'user_id': value['userId'],
212
+ 'course_version_id': value['courseVersionId'],
213
+ 'course_version_number': value['courseVersionNumber'],
196
214
  'first_name': value['firstName'],
197
215
  'last_name': value['lastName'],
198
216
  'enrollment_date_start': value['enrollmentDateStart'],
@@ -44,11 +44,11 @@ export interface GetCourseExport {
44
44
  */
45
45
  exportType: GetCourseExportExportTypeEnum;
46
46
  /**
47
- * IDs of the modules included in the export
47
+ * IDs of the root sections included in the export
48
48
  * @type {Array<string>}
49
49
  * @memberof GetCourseExport
50
50
  */
51
- moduleIds: Array<string>;
51
+ sectionIds: Array<string>;
52
52
  /**
53
53
  * ID of the user who requested the export
54
54
  * @type {number}
@@ -117,7 +117,7 @@ export function instanceOfGetCourseExport(value: object): value is GetCourseExpo
117
117
  if (!('id' in value) || value['id'] === undefined) return false;
118
118
  if (!('courseId' in value) || value['courseId'] === undefined) return false;
119
119
  if (!('exportType' in value) || value['exportType'] === undefined) return false;
120
- if (!('moduleIds' in value) || value['moduleIds'] === undefined) return false;
120
+ if (!('sectionIds' in value) || value['sectionIds'] === undefined) return false;
121
121
  if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
122
122
  if (!('status' in value) || value['status'] === undefined) return false;
123
123
  if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
@@ -138,7 +138,7 @@ export function GetCourseExportFromJSONTyped(json: any, ignoreDiscriminator: boo
138
138
  'courseId': json['course_id'],
139
139
  'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
140
140
  'exportType': json['export_type'],
141
- 'moduleIds': json['module_ids'],
141
+ 'sectionIds': json['section_ids'],
142
142
  'createdBy': json['created_by'],
143
143
  'status': json['status'],
144
144
  'downloadUrl': json['download_url'] == null ? undefined : json['download_url'],
@@ -163,7 +163,7 @@ export function GetCourseExportToJSONTyped(value?: GetCourseExport | null, ignor
163
163
  'course_id': value['courseId'],
164
164
  'course_version_id': value['courseVersionId'],
165
165
  'export_type': value['exportType'],
166
- 'module_ids': value['moduleIds'],
166
+ 'section_ids': value['sectionIds'],
167
167
  'created_by': value['createdBy'],
168
168
  'status': value['status'],
169
169
  'download_url': value['downloadUrl'],
@@ -13,13 +13,6 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
- import type { GetCourseVersionModule } from './GetCourseVersionModule';
17
- import {
18
- GetCourseVersionModuleFromJSON,
19
- GetCourseVersionModuleFromJSONTyped,
20
- GetCourseVersionModuleToJSON,
21
- GetCourseVersionModuleToJSONTyped,
22
- } from './GetCourseVersionModule';
23
16
  import type { ContentLibraryVersionStatus } from './ContentLibraryVersionStatus';
24
17
  import {
25
18
  ContentLibraryVersionStatusFromJSON,
@@ -34,6 +27,13 @@ import {
34
27
  RichTextDocumentToJSON,
35
28
  RichTextDocumentToJSONTyped,
36
29
  } from './RichTextDocument';
30
+ import type { GetCourseVersionSection } from './GetCourseVersionSection';
31
+ import {
32
+ GetCourseVersionSectionFromJSON,
33
+ GetCourseVersionSectionFromJSONTyped,
34
+ GetCourseVersionSectionToJSON,
35
+ GetCourseVersionSectionToJSONTyped,
36
+ } from './GetCourseVersionSection';
37
37
 
38
38
  /**
39
39
  *
@@ -91,10 +91,10 @@ export interface GetCourseVersion {
91
91
  changeNotes?: string | null;
92
92
  /**
93
93
  *
94
- * @type {Array<GetCourseVersionModule>}
94
+ * @type {Array<GetCourseVersionSection>}
95
95
  * @memberof GetCourseVersion
96
96
  */
97
- modules: Array<GetCourseVersionModule>;
97
+ sections: Array<GetCourseVersionSection>;
98
98
  /**
99
99
  *
100
100
  * @type {number}
@@ -128,7 +128,7 @@ export function instanceOfGetCourseVersion(value: object): value is GetCourseVer
128
128
  if (!('name' in value) || value['name'] === undefined) return false;
129
129
  if (!('description' in value) || value['description'] === undefined) return false;
130
130
  if (!('descriptionRich' in value) || value['descriptionRich'] === undefined) return false;
131
- if (!('modules' in value) || value['modules'] === undefined) return false;
131
+ if (!('sections' in value) || value['sections'] === undefined) return false;
132
132
  if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
133
133
  if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
134
134
  return true;
@@ -152,7 +152,7 @@ export function GetCourseVersionFromJSONTyped(json: any, ignoreDiscriminator: bo
152
152
  'description': json['description'],
153
153
  'descriptionRich': RichTextDocumentFromJSON(json['description_rich']),
154
154
  'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
155
- 'modules': ((json['modules'] as Array<any>).map(GetCourseVersionModuleFromJSON)),
155
+ 'sections': ((json['sections'] as Array<any>).map(GetCourseVersionSectionFromJSON)),
156
156
  'createdAt': json['created_at'],
157
157
  'updatedAt': json['updated_at'],
158
158
  'publishedAt': json['published_at'] == null ? undefined : json['published_at'],
@@ -178,7 +178,7 @@ export function GetCourseVersionToJSONTyped(value?: GetCourseVersion | null, ign
178
178
  'description': value['description'],
179
179
  'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
180
180
  'change_notes': value['changeNotes'],
181
- 'modules': ((value['modules'] as Array<any>).map(GetCourseVersionModuleToJSON)),
181
+ 'sections': ((value['sections'] as Array<any>).map(GetCourseVersionSectionToJSON)),
182
182
  'created_at': value['createdAt'],
183
183
  'updated_at': value['updatedAt'],
184
184
  'published_at': value['publishedAt'],
@@ -13,13 +13,13 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
- import type { GetCourseVersionModuleReporting } from './GetCourseVersionModuleReporting';
16
+ import type { GetCourseVersionSectionReporting } from './GetCourseVersionSectionReporting';
17
17
  import {
18
- GetCourseVersionModuleReportingFromJSON,
19
- GetCourseVersionModuleReportingFromJSONTyped,
20
- GetCourseVersionModuleReportingToJSON,
21
- GetCourseVersionModuleReportingToJSONTyped,
22
- } from './GetCourseVersionModuleReporting';
18
+ GetCourseVersionSectionReportingFromJSON,
19
+ GetCourseVersionSectionReportingFromJSONTyped,
20
+ GetCourseVersionSectionReportingToJSON,
21
+ GetCourseVersionSectionReportingToJSONTyped,
22
+ } from './GetCourseVersionSectionReporting';
23
23
 
24
24
  /**
25
25
  *
@@ -89,10 +89,10 @@ export interface GetCourseVersionReporting {
89
89
  totalDurationSeconds: number;
90
90
  /**
91
91
  *
92
- * @type {Array<GetCourseVersionModuleReporting>}
92
+ * @type {Array<GetCourseVersionSectionReporting>}
93
93
  * @memberof GetCourseVersionReporting
94
94
  */
95
- modules: Array<GetCourseVersionModuleReporting>;
95
+ sections: Array<GetCourseVersionSectionReporting>;
96
96
  }
97
97
 
98
98
  /**
@@ -109,7 +109,7 @@ export function instanceOfGetCourseVersionReporting(value: object): value is Get
109
109
  if (!('completionRatePercentage' in value) || value['completionRatePercentage'] === undefined) return false;
110
110
  if (!('avgScorePercentage' in value) || value['avgScorePercentage'] === undefined) return false;
111
111
  if (!('totalDurationSeconds' in value) || value['totalDurationSeconds'] === undefined) return false;
112
- if (!('modules' in value) || value['modules'] === undefined) return false;
112
+ if (!('sections' in value) || value['sections'] === undefined) return false;
113
113
  return true;
114
114
  }
115
115
 
@@ -133,7 +133,7 @@ export function GetCourseVersionReportingFromJSONTyped(json: any, ignoreDiscrimi
133
133
  'completionRatePercentage': json['completion_rate_percentage'],
134
134
  'avgScorePercentage': json['avg_score_percentage'],
135
135
  'totalDurationSeconds': json['total_duration_seconds'],
136
- 'modules': ((json['modules'] as Array<any>).map(GetCourseVersionModuleReportingFromJSON)),
136
+ 'sections': ((json['sections'] as Array<any>).map(GetCourseVersionSectionReportingFromJSON)),
137
137
  };
138
138
  }
139
139
 
@@ -158,7 +158,7 @@ export function GetCourseVersionReportingToJSONTyped(value?: GetCourseVersionRep
158
158
  'completion_rate_percentage': value['completionRatePercentage'],
159
159
  'avg_score_percentage': value['avgScorePercentage'],
160
160
  'total_duration_seconds': value['totalDurationSeconds'],
161
- 'modules': ((value['modules'] as Array<any>).map(GetCourseVersionModuleReportingToJSON)),
161
+ 'sections': ((value['sections'] as Array<any>).map(GetCourseVersionSectionReportingToJSON)),
162
162
  };
163
163
  }
164
164
 
@@ -13,13 +13,6 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
- import type { GetCourseVersionItem } from './GetCourseVersionItem';
17
- import {
18
- GetCourseVersionItemFromJSON,
19
- GetCourseVersionItemFromJSONTyped,
20
- GetCourseVersionItemToJSON,
21
- GetCourseVersionItemToJSONTyped,
22
- } from './GetCourseVersionItem';
23
16
  import type { RichTextDocument } from './RichTextDocument';
24
17
  import {
25
18
  RichTextDocumentFromJSON,
@@ -27,69 +20,76 @@ import {
27
20
  RichTextDocumentToJSON,
28
21
  RichTextDocumentToJSONTyped,
29
22
  } from './RichTextDocument';
23
+ import type { GetCourseVersionSectionChild } from './GetCourseVersionSectionChild';
24
+ import {
25
+ GetCourseVersionSectionChildFromJSON,
26
+ GetCourseVersionSectionChildFromJSONTyped,
27
+ GetCourseVersionSectionChildToJSON,
28
+ GetCourseVersionSectionChildToJSONTyped,
29
+ } from './GetCourseVersionSectionChild';
30
30
 
31
31
  /**
32
32
  *
33
33
  * @export
34
- * @interface GetCourseVersionModule
34
+ * @interface GetCourseVersionSection
35
35
  */
36
- export interface GetCourseVersionModule {
36
+ export interface GetCourseVersionSection {
37
37
  /**
38
38
  *
39
39
  * @type {string}
40
- * @memberof GetCourseVersionModule
40
+ * @memberof GetCourseVersionSection
41
41
  */
42
42
  id: string;
43
43
  /**
44
44
  *
45
45
  * @type {string}
46
- * @memberof GetCourseVersionModule
46
+ * @memberof GetCourseVersionSection
47
47
  */
48
48
  name: string;
49
49
  /**
50
50
  *
51
51
  * @type {string}
52
- * @memberof GetCourseVersionModule
52
+ * @memberof GetCourseVersionSection
53
53
  */
54
54
  description: string;
55
55
  /**
56
56
  *
57
57
  * @type {RichTextDocument}
58
- * @memberof GetCourseVersionModule
58
+ * @memberof GetCourseVersionSection
59
59
  */
60
60
  descriptionRich: RichTextDocument;
61
61
  /**
62
62
  *
63
63
  * @type {number}
64
- * @memberof GetCourseVersionModule
64
+ * @memberof GetCourseVersionSection
65
65
  */
66
66
  displayOrder: number;
67
67
  /**
68
68
  *
69
- * @type {Array<GetCourseVersionItem>}
70
- * @memberof GetCourseVersionModule
69
+ * @type {Array<GetCourseVersionSectionChild>}
70
+ * @memberof GetCourseVersionSection
71
71
  */
72
- items: Array<GetCourseVersionItem>;
72
+ children: Array<GetCourseVersionSectionChild>;
73
73
  }
74
74
 
75
75
  /**
76
- * Check if a given object implements the GetCourseVersionModule interface.
76
+ * Check if a given object implements the GetCourseVersionSection interface.
77
77
  */
78
- export function instanceOfGetCourseVersionModule(value: object): value is GetCourseVersionModule {
78
+ export function instanceOfGetCourseVersionSection(value: object): value is GetCourseVersionSection {
79
79
  if (!('id' in value) || value['id'] === undefined) return false;
80
80
  if (!('name' in value) || value['name'] === undefined) return false;
81
81
  if (!('description' in value) || value['description'] === undefined) return false;
82
82
  if (!('descriptionRich' in value) || value['descriptionRich'] === undefined) return false;
83
83
  if (!('displayOrder' in value) || value['displayOrder'] === undefined) return false;
84
- if (!('items' in value) || value['items'] === undefined) return false;
84
+ if (!('children' in value) || value['children'] === undefined) return false;
85
85
  return true;
86
86
  }
87
87
 
88
- export function GetCourseVersionModuleFromJSON(json: any): GetCourseVersionModule {
89
- return GetCourseVersionModuleFromJSONTyped(json, false);
88
+ export function GetCourseVersionSectionFromJSON(json: any): GetCourseVersionSection {
89
+ return GetCourseVersionSectionFromJSONTyped(json, false);
90
90
  }
91
91
 
92
- export function GetCourseVersionModuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionModule {
92
+ export function GetCourseVersionSectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionSection {
93
93
  if (json == null) {
94
94
  return json;
95
95
  }
@@ -100,15 +100,15 @@ export function GetCourseVersionModuleFromJSONTyped(json: any, ignoreDiscriminat
100
100
  'description': json['description'],
101
101
  'descriptionRich': RichTextDocumentFromJSON(json['description_rich']),
102
102
  'displayOrder': json['display_order'],
103
- 'items': ((json['items'] as Array<any>).map(GetCourseVersionItemFromJSON)),
103
+ 'children': ((json['children'] as Array<any>).map(GetCourseVersionSectionChildFromJSON)),
104
104
  };
105
105
  }
106
106
 
107
- export function GetCourseVersionModuleToJSON(json: any): GetCourseVersionModule {
108
- return GetCourseVersionModuleToJSONTyped(json, false);
107
+ export function GetCourseVersionSectionToJSON(json: any): GetCourseVersionSection {
108
+ return GetCourseVersionSectionToJSONTyped(json, false);
109
109
  }
110
110
 
111
- export function GetCourseVersionModuleToJSONTyped(value?: GetCourseVersionModule | null, ignoreDiscriminator: boolean = false): any {
111
+ export function GetCourseVersionSectionToJSONTyped(value?: GetCourseVersionSection | null, ignoreDiscriminator: boolean = false): any {
112
112
  if (value == null) {
113
113
  return value;
114
114
  }
@@ -120,7 +120,7 @@ export function GetCourseVersionModuleToJSONTyped(value?: GetCourseVersionModule
120
120
  'description': value['description'],
121
121
  'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
122
122
  'display_order': value['displayOrder'],
123
- 'items': ((value['items'] as Array<any>).map(GetCourseVersionItemToJSON)),
123
+ 'children': ((value['children'] as Array<any>).map(GetCourseVersionSectionChildToJSON)),
124
124
  };
125
125
  }
126
126