@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
@@ -0,0 +1,56 @@
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 { GetCourseVersionItemFromJSON, GetCourseVersionItemToJSON, } from './GetCourseVersionItem';
15
+ import { GetCourseVersionSectionFromJSON, GetCourseVersionSectionToJSON, } from './GetCourseVersionSection';
16
+ /**
17
+ * @export
18
+ */
19
+ export const GetCourseVersionSectionChildKindEnum = {
20
+ Section: 'section',
21
+ Item: 'item'
22
+ };
23
+ /**
24
+ * Check if a given object implements the GetCourseVersionSectionChild interface.
25
+ */
26
+ export function instanceOfGetCourseVersionSectionChild(value) {
27
+ if (!('kind' in value) || value['kind'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ export function GetCourseVersionSectionChildFromJSON(json) {
32
+ return GetCourseVersionSectionChildFromJSONTyped(json, false);
33
+ }
34
+ export function GetCourseVersionSectionChildFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'kind': json['kind'],
40
+ 'section': json['section'] == null ? undefined : GetCourseVersionSectionFromJSON(json['section']),
41
+ 'item': json['item'] == null ? undefined : GetCourseVersionItemFromJSON(json['item']),
42
+ };
43
+ }
44
+ export function GetCourseVersionSectionChildToJSON(json) {
45
+ return GetCourseVersionSectionChildToJSONTyped(json, false);
46
+ }
47
+ export function GetCourseVersionSectionChildToJSONTyped(value, ignoreDiscriminator = false) {
48
+ if (value == null) {
49
+ return value;
50
+ }
51
+ return {
52
+ 'kind': value['kind'],
53
+ 'section': GetCourseVersionSectionToJSON(value['section']),
54
+ 'item': GetCourseVersionItemToJSON(value['item']),
55
+ };
56
+ }
@@ -0,0 +1,99 @@
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 { GetCourseVersionItemReporting } from './GetCourseVersionItemReporting';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface GetCourseVersionSectionReporting
17
+ */
18
+ export interface GetCourseVersionSectionReporting {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof GetCourseVersionSectionReporting
23
+ */
24
+ sectionId: string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof GetCourseVersionSectionReporting
29
+ */
30
+ name: string;
31
+ /**
32
+ *
33
+ * @type {number}
34
+ * @memberof GetCourseVersionSectionReporting
35
+ */
36
+ itemCount: number;
37
+ /**
38
+ *
39
+ * @type {number}
40
+ * @memberof GetCourseVersionSectionReporting
41
+ */
42
+ requiredItemCount: number;
43
+ /**
44
+ *
45
+ * @type {number}
46
+ * @memberof GetCourseVersionSectionReporting
47
+ */
48
+ enrollmentCount: number;
49
+ /**
50
+ *
51
+ * @type {number}
52
+ * @memberof GetCourseVersionSectionReporting
53
+ */
54
+ completedCount: number;
55
+ /**
56
+ *
57
+ * @type {number}
58
+ * @memberof GetCourseVersionSectionReporting
59
+ */
60
+ inProgressCount: number;
61
+ /**
62
+ *
63
+ * @type {number}
64
+ * @memberof GetCourseVersionSectionReporting
65
+ */
66
+ notStartedCount: number;
67
+ /**
68
+ *
69
+ * @type {number}
70
+ * @memberof GetCourseVersionSectionReporting
71
+ */
72
+ completionRatePercentage: number | null;
73
+ /**
74
+ *
75
+ * @type {number}
76
+ * @memberof GetCourseVersionSectionReporting
77
+ */
78
+ avgScorePercentage: number | null;
79
+ /**
80
+ *
81
+ * @type {number}
82
+ * @memberof GetCourseVersionSectionReporting
83
+ */
84
+ totalDurationSeconds: number;
85
+ /**
86
+ *
87
+ * @type {Array<GetCourseVersionItemReporting>}
88
+ * @memberof GetCourseVersionSectionReporting
89
+ */
90
+ items: Array<GetCourseVersionItemReporting>;
91
+ }
92
+ /**
93
+ * Check if a given object implements the GetCourseVersionSectionReporting interface.
94
+ */
95
+ export declare function instanceOfGetCourseVersionSectionReporting(value: object): value is GetCourseVersionSectionReporting;
96
+ export declare function GetCourseVersionSectionReportingFromJSON(json: any): GetCourseVersionSectionReporting;
97
+ export declare function GetCourseVersionSectionReportingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionSectionReporting;
98
+ export declare function GetCourseVersionSectionReportingToJSON(json: any): GetCourseVersionSectionReporting;
99
+ export declare function GetCourseVersionSectionReportingToJSONTyped(value?: GetCourseVersionSectionReporting | null, ignoreDiscriminator?: boolean): any;
@@ -13,10 +13,10 @@
13
13
  */
14
14
  import { GetCourseVersionItemReportingFromJSON, GetCourseVersionItemReportingToJSON, } from './GetCourseVersionItemReporting';
15
15
  /**
16
- * Check if a given object implements the GetCourseVersionModuleReporting interface.
16
+ * Check if a given object implements the GetCourseVersionSectionReporting interface.
17
17
  */
18
- export function instanceOfGetCourseVersionModuleReporting(value) {
19
- if (!('moduleId' in value) || value['moduleId'] === undefined)
18
+ export function instanceOfGetCourseVersionSectionReporting(value) {
19
+ if (!('sectionId' in value) || value['sectionId'] === undefined)
20
20
  return false;
21
21
  if (!('name' in value) || value['name'] === undefined)
22
22
  return false;
@@ -42,15 +42,15 @@ export function instanceOfGetCourseVersionModuleReporting(value) {
42
42
  return false;
43
43
  return true;
44
44
  }
45
- export function GetCourseVersionModuleReportingFromJSON(json) {
46
- return GetCourseVersionModuleReportingFromJSONTyped(json, false);
45
+ export function GetCourseVersionSectionReportingFromJSON(json) {
46
+ return GetCourseVersionSectionReportingFromJSONTyped(json, false);
47
47
  }
48
- export function GetCourseVersionModuleReportingFromJSONTyped(json, ignoreDiscriminator) {
48
+ export function GetCourseVersionSectionReportingFromJSONTyped(json, ignoreDiscriminator) {
49
49
  if (json == null) {
50
50
  return json;
51
51
  }
52
52
  return {
53
- 'moduleId': json['module_id'],
53
+ 'sectionId': json['section_id'],
54
54
  'name': json['name'],
55
55
  'itemCount': json['item_count'],
56
56
  'requiredItemCount': json['required_item_count'],
@@ -64,15 +64,15 @@ export function GetCourseVersionModuleReportingFromJSONTyped(json, ignoreDiscrim
64
64
  'items': (json['items'].map(GetCourseVersionItemReportingFromJSON)),
65
65
  };
66
66
  }
67
- export function GetCourseVersionModuleReportingToJSON(json) {
68
- return GetCourseVersionModuleReportingToJSONTyped(json, false);
67
+ export function GetCourseVersionSectionReportingToJSON(json) {
68
+ return GetCourseVersionSectionReportingToJSONTyped(json, false);
69
69
  }
70
- export function GetCourseVersionModuleReportingToJSONTyped(value, ignoreDiscriminator = false) {
70
+ export function GetCourseVersionSectionReportingToJSONTyped(value, ignoreDiscriminator = false) {
71
71
  if (value == null) {
72
72
  return value;
73
73
  }
74
74
  return {
75
- 'module_id': value['moduleId'],
75
+ 'section_id': value['sectionId'],
76
76
  'name': value['name'],
77
77
  'item_count': value['itemCount'],
78
78
  'required_item_count': value['requiredItemCount'],
@@ -34,7 +34,7 @@ export interface GetPermission {
34
34
  */
35
35
  description?: string | null;
36
36
  /**
37
- * Grouping domain (e.g. course, module, content)
37
+ * Grouping domain (e.g. course, section, content)
38
38
  * @type {string}
39
39
  * @memberof GetPermission
40
40
  */
@@ -28,11 +28,11 @@ export interface PostCourseExport {
28
28
  */
29
29
  exportType: PostCourseExportExportTypeEnum;
30
30
  /**
31
- * IDs of the modules to include in the export
31
+ * IDs of the root sections to include in the export. Descendant sections are included automatically.
32
32
  * @type {Array<string>}
33
33
  * @memberof PostCourseExport
34
34
  */
35
- moduleIds: Array<string>;
35
+ sectionIds: Array<string>;
36
36
  }
37
37
  /**
38
38
  * @export
@@ -27,7 +27,7 @@ export function instanceOfPostCourseExport(value) {
27
27
  return false;
28
28
  if (!('exportType' in value) || value['exportType'] === undefined)
29
29
  return false;
30
- if (!('moduleIds' in value) || value['moduleIds'] === undefined)
30
+ if (!('sectionIds' in value) || value['sectionIds'] === undefined)
31
31
  return false;
32
32
  return true;
33
33
  }
@@ -41,7 +41,7 @@ export function PostCourseExportFromJSONTyped(json, ignoreDiscriminator) {
41
41
  return {
42
42
  'courseVersionId': json['course_version_id'],
43
43
  'exportType': json['export_type'],
44
- 'moduleIds': json['module_ids'],
44
+ 'sectionIds': json['section_ids'],
45
45
  };
46
46
  }
47
47
  export function PostCourseExportToJSON(json) {
@@ -54,6 +54,6 @@ export function PostCourseExportToJSONTyped(value, ignoreDiscriminator = false)
54
54
  return {
55
55
  'course_version_id': value['courseVersionId'],
56
56
  'export_type': value['exportType'],
57
- 'module_ids': value['moduleIds'],
57
+ 'section_ids': value['sectionIds'],
58
58
  };
59
59
  }
@@ -32,7 +32,7 @@ export interface PostCourseResume {
32
32
  * @type {string}
33
33
  * @memberof PostCourseResume
34
34
  */
35
- moduleId: string;
35
+ sectionId: string;
36
36
  /**
37
37
  *
38
38
  * @type {string}
@@ -33,7 +33,7 @@ export function instanceOfPostCourseResume(value) {
33
33
  return false;
34
34
  if (!('courseVersionId' in value) || value['courseVersionId'] === undefined)
35
35
  return false;
36
- if (!('moduleId' in value) || value['moduleId'] === undefined)
36
+ if (!('sectionId' in value) || value['sectionId'] === undefined)
37
37
  return false;
38
38
  if (!('itemId' in value) || value['itemId'] === undefined)
39
39
  return false;
@@ -61,7 +61,7 @@ export function PostCourseResumeFromJSONTyped(json, ignoreDiscriminator) {
61
61
  return {
62
62
  'courseId': json['course_id'],
63
63
  'courseVersionId': json['course_version_id'],
64
- 'moduleId': json['module_id'],
64
+ 'sectionId': json['section_id'],
65
65
  'itemId': json['item_id'],
66
66
  'kind': json['kind'],
67
67
  'sessionId': json['session_id'],
@@ -81,7 +81,7 @@ export function PostCourseResumeToJSONTyped(value, ignoreDiscriminator = false)
81
81
  return {
82
82
  'course_id': value['courseId'],
83
83
  'course_version_id': value['courseVersionId'],
84
- 'module_id': value['moduleId'],
84
+ 'section_id': value['sectionId'],
85
85
  'item_id': value['itemId'],
86
86
  'kind': value['kind'],
87
87
  'session_id': value['sessionId'],
@@ -21,6 +21,16 @@ export interface PostCourseVersionPublish {
21
21
  * @memberof PostCourseVersionPublish
22
22
  */
23
23
  changeNotes?: string;
24
+ /**
25
+ * When true, assign all Enrolled, InProgress, and Suspended Student enrollments
26
+ * for this course to the newly published version. Completed and other historical
27
+ * enrollments remain pinned to their original version. Existing progress and
28
+ * session history remain stored against the previous version and are not transferred.
29
+ *
30
+ * @type {boolean}
31
+ * @memberof PostCourseVersionPublish
32
+ */
33
+ promoteActiveEnrollments?: boolean;
24
34
  }
25
35
  /**
26
36
  * Check if a given object implements the PostCourseVersionPublish interface.
@@ -26,6 +26,7 @@ export function PostCourseVersionPublishFromJSONTyped(json, ignoreDiscriminator)
26
26
  }
27
27
  return {
28
28
  'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
29
+ 'promoteActiveEnrollments': json['promote_active_enrollments'] == null ? undefined : json['promote_active_enrollments'],
29
30
  };
30
31
  }
31
32
  export function PostCourseVersionPublishToJSON(json) {
@@ -37,5 +38,6 @@ export function PostCourseVersionPublishToJSONTyped(value, ignoreDiscriminator =
37
38
  }
38
39
  return {
39
40
  'change_notes': value['changeNotes'],
41
+ 'promote_active_enrollments': value['promoteActiveEnrollments'],
40
42
  };
41
43
  }
@@ -0,0 +1,57 @@
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 { RichTextDocument } from './RichTextDocument';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface PostCourseVersionSection
17
+ */
18
+ export interface PostCourseVersionSection {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof PostCourseVersionSection
23
+ */
24
+ name: string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof PostCourseVersionSection
29
+ */
30
+ description?: string;
31
+ /**
32
+ *
33
+ * @type {RichTextDocument}
34
+ * @memberof PostCourseVersionSection
35
+ */
36
+ descriptionRich?: RichTextDocument;
37
+ /**
38
+ * Parent section. Omit to create a root section.
39
+ * @type {string}
40
+ * @memberof PostCourseVersionSection
41
+ */
42
+ parentSectionId?: string;
43
+ /**
44
+ *
45
+ * @type {number}
46
+ * @memberof PostCourseVersionSection
47
+ */
48
+ position?: number;
49
+ }
50
+ /**
51
+ * Check if a given object implements the PostCourseVersionSection interface.
52
+ */
53
+ export declare function instanceOfPostCourseVersionSection(value: object): value is PostCourseVersionSection;
54
+ export declare function PostCourseVersionSectionFromJSON(json: any): PostCourseVersionSection;
55
+ export declare function PostCourseVersionSectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionSection;
56
+ export declare function PostCourseVersionSectionToJSON(json: any): PostCourseVersionSection;
57
+ export declare function PostCourseVersionSectionToJSONTyped(value?: PostCourseVersionSection | null, ignoreDiscriminator?: boolean): any;
@@ -13,17 +13,17 @@
13
13
  */
14
14
  import { RichTextDocumentFromJSON, RichTextDocumentToJSON, } from './RichTextDocument';
15
15
  /**
16
- * Check if a given object implements the PostCourseVersionModule interface.
16
+ * Check if a given object implements the PostCourseVersionSection interface.
17
17
  */
18
- export function instanceOfPostCourseVersionModule(value) {
18
+ export function instanceOfPostCourseVersionSection(value) {
19
19
  if (!('name' in value) || value['name'] === undefined)
20
20
  return false;
21
21
  return true;
22
22
  }
23
- export function PostCourseVersionModuleFromJSON(json) {
24
- return PostCourseVersionModuleFromJSONTyped(json, false);
23
+ export function PostCourseVersionSectionFromJSON(json) {
24
+ return PostCourseVersionSectionFromJSONTyped(json, false);
25
25
  }
26
- export function PostCourseVersionModuleFromJSONTyped(json, ignoreDiscriminator) {
26
+ export function PostCourseVersionSectionFromJSONTyped(json, ignoreDiscriminator) {
27
27
  if (json == null) {
28
28
  return json;
29
29
  }
@@ -31,13 +31,14 @@ export function PostCourseVersionModuleFromJSONTyped(json, ignoreDiscriminator)
31
31
  'name': json['name'],
32
32
  'description': json['description'] == null ? undefined : json['description'],
33
33
  'descriptionRich': json['description_rich'] == null ? undefined : RichTextDocumentFromJSON(json['description_rich']),
34
+ 'parentSectionId': json['parent_section_id'] == null ? undefined : json['parent_section_id'],
34
35
  'position': json['position'] == null ? undefined : json['position'],
35
36
  };
36
37
  }
37
- export function PostCourseVersionModuleToJSON(json) {
38
- return PostCourseVersionModuleToJSONTyped(json, false);
38
+ export function PostCourseVersionSectionToJSON(json) {
39
+ return PostCourseVersionSectionToJSONTyped(json, false);
39
40
  }
40
- export function PostCourseVersionModuleToJSONTyped(value, ignoreDiscriminator = false) {
41
+ export function PostCourseVersionSectionToJSONTyped(value, ignoreDiscriminator = false) {
41
42
  if (value == null) {
42
43
  return value;
43
44
  }
@@ -45,6 +46,7 @@ export function PostCourseVersionModuleToJSONTyped(value, ignoreDiscriminator =
45
46
  'name': value['name'],
46
47
  'description': value['description'],
47
48
  'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
49
+ 'parent_section_id': value['parentSectionId'],
48
50
  'position': value['position'],
49
51
  };
50
52
  }
@@ -0,0 +1,44 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface PostCourseVersionSectionDuplicate
16
+ */
17
+ export interface PostCourseVersionSectionDuplicate {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof PostCourseVersionSectionDuplicate
22
+ */
23
+ name?: string;
24
+ /**
25
+ * New parent section. Omit to duplicate at the root.
26
+ * @type {string}
27
+ * @memberof PostCourseVersionSectionDuplicate
28
+ */
29
+ targetSectionId?: string;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof PostCourseVersionSectionDuplicate
34
+ */
35
+ position?: number;
36
+ }
37
+ /**
38
+ * Check if a given object implements the PostCourseVersionSectionDuplicate interface.
39
+ */
40
+ export declare function instanceOfPostCourseVersionSectionDuplicate(value: object): value is PostCourseVersionSectionDuplicate;
41
+ export declare function PostCourseVersionSectionDuplicateFromJSON(json: any): PostCourseVersionSectionDuplicate;
42
+ export declare function PostCourseVersionSectionDuplicateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionSectionDuplicate;
43
+ export declare function PostCourseVersionSectionDuplicateToJSON(json: any): PostCourseVersionSectionDuplicate;
44
+ export declare function PostCourseVersionSectionDuplicateToJSONTyped(value?: PostCourseVersionSectionDuplicate | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,45 @@
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 PostCourseVersionSectionDuplicate interface.
16
+ */
17
+ export function instanceOfPostCourseVersionSectionDuplicate(value) {
18
+ return true;
19
+ }
20
+ export function PostCourseVersionSectionDuplicateFromJSON(json) {
21
+ return PostCourseVersionSectionDuplicateFromJSONTyped(json, false);
22
+ }
23
+ export function PostCourseVersionSectionDuplicateFromJSONTyped(json, ignoreDiscriminator) {
24
+ if (json == null) {
25
+ return json;
26
+ }
27
+ return {
28
+ 'name': json['name'] == null ? undefined : json['name'],
29
+ 'targetSectionId': json['target_section_id'] == null ? undefined : json['target_section_id'],
30
+ 'position': json['position'] == null ? undefined : json['position'],
31
+ };
32
+ }
33
+ export function PostCourseVersionSectionDuplicateToJSON(json) {
34
+ return PostCourseVersionSectionDuplicateToJSONTyped(json, false);
35
+ }
36
+ export function PostCourseVersionSectionDuplicateToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'name': value['name'],
42
+ 'target_section_id': value['targetSectionId'],
43
+ 'position': value['position'],
44
+ };
45
+ }
@@ -48,6 +48,15 @@ export interface PutCourseEnrollment {
48
48
  * @memberof PutCourseEnrollment
49
49
  */
50
50
  notes?: string;
51
+ /**
52
+ * Reassign this learner enrollment to a published version of the same course.
53
+ * Only active or suspended Student enrollments can be reassigned. Progress and
54
+ * session history for the previous version are retained but are not transferred.
55
+ *
56
+ * @type {string}
57
+ * @memberof PutCourseEnrollment
58
+ */
59
+ courseVersionId?: string;
51
60
  }
52
61
  /**
53
62
  * @export
@@ -49,6 +49,7 @@ export function PutCourseEnrollmentFromJSONTyped(json, ignoreDiscriminator) {
49
49
  'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
50
50
  'extensionDays': json['extension_days'] == null ? undefined : json['extension_days'],
51
51
  'notes': json['notes'] == null ? undefined : json['notes'],
52
+ 'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
52
53
  };
53
54
  }
54
55
  export function PutCourseEnrollmentToJSON(json) {
@@ -64,5 +65,6 @@ export function PutCourseEnrollmentToJSONTyped(value, ignoreDiscriminator = fals
64
65
  'enrollment_date_end': value['enrollmentDateEnd'],
65
66
  'extension_days': value['extensionDays'],
66
67
  'notes': value['notes'],
68
+ 'course_version_id': value['courseVersionId'],
67
69
  };
68
70
  }
@@ -27,7 +27,7 @@ export interface PutCourseVersionItem {
27
27
  * @type {string}
28
28
  * @memberof PutCourseVersionItem
29
29
  */
30
- targetModuleId?: string;
30
+ targetSectionId?: string;
31
31
  /**
32
32
  *
33
33
  * @type {string}
@@ -34,7 +34,7 @@ export function PutCourseVersionItemFromJSONTyped(json, ignoreDiscriminator) {
34
34
  }
35
35
  return {
36
36
  'libraryVersionId': json['library_version_id'] == null ? undefined : json['library_version_id'],
37
- 'targetModuleId': json['target_module_id'] == null ? undefined : json['target_module_id'],
37
+ 'targetSectionId': json['target_section_id'] == null ? undefined : json['target_section_id'],
38
38
  'displayName': json['display_name'] == null ? undefined : json['display_name'],
39
39
  'position': json['position'] == null ? undefined : json['position'],
40
40
  'isVisible': json['is_visible'] == null ? undefined : json['is_visible'],
@@ -54,7 +54,7 @@ export function PutCourseVersionItemToJSONTyped(value, ignoreDiscriminator = fal
54
54
  }
55
55
  return {
56
56
  'library_version_id': value['libraryVersionId'],
57
- 'target_module_id': value['targetModuleId'],
57
+ 'target_section_id': value['targetSectionId'],
58
58
  'display_name': value['displayName'],
59
59
  'position': value['position'],
60
60
  'is_visible': value['isVisible'],
@@ -0,0 +1,58 @@
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 PutCourseVersionOutlineEntryMove
16
+ */
17
+ export interface PutCourseVersionOutlineEntryMove {
18
+ /**
19
+ *
20
+ * @type {PutCourseVersionOutlineEntryMoveEntryKindEnum}
21
+ * @memberof PutCourseVersionOutlineEntryMove
22
+ */
23
+ entryKind: PutCourseVersionOutlineEntryMoveEntryKindEnum;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof PutCourseVersionOutlineEntryMove
28
+ */
29
+ entryId: string;
30
+ /**
31
+ * Destination parent. Null is allowed only for sections and moves them to the course root.
32
+ * @type {string}
33
+ * @memberof PutCourseVersionOutlineEntryMove
34
+ */
35
+ targetSectionId: string | null;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof PutCourseVersionOutlineEntryMove
40
+ */
41
+ position?: number;
42
+ }
43
+ /**
44
+ * @export
45
+ */
46
+ export declare const PutCourseVersionOutlineEntryMoveEntryKindEnum: {
47
+ readonly Section: "section";
48
+ readonly Item: "item";
49
+ };
50
+ export type PutCourseVersionOutlineEntryMoveEntryKindEnum = typeof PutCourseVersionOutlineEntryMoveEntryKindEnum[keyof typeof PutCourseVersionOutlineEntryMoveEntryKindEnum];
51
+ /**
52
+ * Check if a given object implements the PutCourseVersionOutlineEntryMove interface.
53
+ */
54
+ export declare function instanceOfPutCourseVersionOutlineEntryMove(value: object): value is PutCourseVersionOutlineEntryMove;
55
+ export declare function PutCourseVersionOutlineEntryMoveFromJSON(json: any): PutCourseVersionOutlineEntryMove;
56
+ export declare function PutCourseVersionOutlineEntryMoveFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCourseVersionOutlineEntryMove;
57
+ export declare function PutCourseVersionOutlineEntryMoveToJSON(json: any): PutCourseVersionOutlineEntryMove;
58
+ export declare function PutCourseVersionOutlineEntryMoveToJSONTyped(value?: PutCourseVersionOutlineEntryMove | null, ignoreDiscriminator?: boolean): any;