@easyedu/js-lsm-api 1.96.0 → 1.97.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 (127) 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/GetCourseExport.d.ts +2 -2
  12. package/dist/esm/models/GetCourseExport.js +3 -3
  13. package/dist/esm/models/GetCourseVersion.d.ts +3 -3
  14. package/dist/esm/models/GetCourseVersion.js +4 -4
  15. package/dist/esm/models/GetCourseVersionReporting.d.ts +3 -3
  16. package/dist/esm/models/GetCourseVersionReporting.js +4 -4
  17. package/dist/esm/models/GetCourseVersionSection.d.ts +64 -0
  18. package/dist/esm/models/{GetCourseVersionModule.js → GetCourseVersionSection.js} +12 -12
  19. package/dist/esm/models/GetCourseVersionSectionChild.d.ts +54 -0
  20. package/dist/esm/models/GetCourseVersionSectionChild.js +56 -0
  21. package/dist/esm/models/GetCourseVersionSectionReporting.d.ts +99 -0
  22. package/dist/esm/models/{GetCourseVersionModuleReporting.js → GetCourseVersionSectionReporting.js} +11 -11
  23. package/dist/esm/models/GetPermission.d.ts +1 -1
  24. package/dist/esm/models/PostCourseExport.d.ts +2 -2
  25. package/dist/esm/models/PostCourseExport.js +3 -3
  26. package/dist/esm/models/PostCourseResume.d.ts +1 -1
  27. package/dist/esm/models/PostCourseResume.js +3 -3
  28. package/dist/esm/models/PostCourseVersionSection.d.ts +57 -0
  29. package/dist/esm/models/{PostCourseVersionModule.js → PostCourseVersionSection.js} +10 -8
  30. package/dist/esm/models/PostCourseVersionSectionDuplicate.d.ts +44 -0
  31. package/dist/esm/models/PostCourseVersionSectionDuplicate.js +45 -0
  32. package/dist/esm/models/PutCourseVersionItem.d.ts +1 -1
  33. package/dist/esm/models/PutCourseVersionItem.js +2 -2
  34. package/dist/esm/models/PutCourseVersionOutlineEntryMove.d.ts +58 -0
  35. package/dist/esm/models/PutCourseVersionOutlineEntryMove.js +60 -0
  36. package/dist/esm/models/PutCourseVersionSection.d.ts +45 -0
  37. package/dist/esm/models/{PutCourseVersionModule.js → PutCourseVersionSection.js} +8 -10
  38. package/dist/esm/models/PutRolePermissions.d.ts +1 -1
  39. package/dist/esm/models/index.d.ts +7 -7
  40. package/dist/esm/models/index.js +7 -7
  41. package/dist/models/GetCourseExport.d.ts +2 -2
  42. package/dist/models/GetCourseExport.js +3 -3
  43. package/dist/models/GetCourseVersion.d.ts +3 -3
  44. package/dist/models/GetCourseVersion.js +4 -4
  45. package/dist/models/GetCourseVersionReporting.d.ts +3 -3
  46. package/dist/models/GetCourseVersionReporting.js +4 -4
  47. package/dist/models/GetCourseVersionSection.d.ts +64 -0
  48. package/dist/models/{GetCourseVersionModule.js → GetCourseVersionSection.js} +17 -17
  49. package/dist/models/GetCourseVersionSectionChild.d.ts +54 -0
  50. package/dist/models/GetCourseVersionSectionChild.js +64 -0
  51. package/dist/models/GetCourseVersionSectionReporting.d.ts +99 -0
  52. package/dist/models/{GetCourseVersionModuleReporting.js → GetCourseVersionSectionReporting.js} +16 -16
  53. package/dist/models/GetPermission.d.ts +1 -1
  54. package/dist/models/PostCourseExport.d.ts +2 -2
  55. package/dist/models/PostCourseExport.js +3 -3
  56. package/dist/models/PostCourseResume.d.ts +1 -1
  57. package/dist/models/PostCourseResume.js +3 -3
  58. package/dist/models/PostCourseVersionSection.d.ts +57 -0
  59. package/dist/models/{PostCourseVersionModule.js → PostCourseVersionSection.js} +15 -13
  60. package/dist/models/PostCourseVersionSectionDuplicate.d.ts +44 -0
  61. package/dist/models/PostCourseVersionSectionDuplicate.js +52 -0
  62. package/dist/models/PutCourseVersionItem.d.ts +1 -1
  63. package/dist/models/PutCourseVersionItem.js +2 -2
  64. package/dist/models/PutCourseVersionOutlineEntryMove.d.ts +58 -0
  65. package/dist/models/PutCourseVersionOutlineEntryMove.js +68 -0
  66. package/dist/models/PutCourseVersionSection.d.ts +45 -0
  67. package/dist/models/{PutCourseVersionModule.js → PutCourseVersionSection.js} +13 -15
  68. package/dist/models/PutRolePermissions.d.ts +1 -1
  69. package/dist/models/index.d.ts +7 -7
  70. package/dist/models/index.js +7 -7
  71. package/docs/CourseApi.md +94 -166
  72. package/docs/GetCourseExport.md +2 -2
  73. package/docs/GetCourseVersion.md +2 -2
  74. package/docs/GetCourseVersionReporting.md +2 -2
  75. package/docs/{GetCourseVersionModule.md → GetCourseVersionSection.md} +6 -6
  76. package/docs/{PutCourseVersionItemReorder.md → GetCourseVersionSectionChild.md} +11 -6
  77. package/docs/{GetCourseVersionModuleReporting.md → GetCourseVersionSectionReporting.md} +6 -6
  78. package/docs/PostCourseExport.md +2 -2
  79. package/docs/PostCourseResume.md +2 -2
  80. package/docs/{PostCourseVersionModule.md → PostCourseVersionSection.md} +6 -4
  81. package/docs/{PostCourseVersionModuleDuplicate.md → PostCourseVersionSectionDuplicate.md} +6 -4
  82. package/docs/PutCourseVersionItem.md +2 -2
  83. package/docs/{PutCourseVersionModuleReorder.md → PutCourseVersionOutlineEntryMove.md} +12 -6
  84. package/docs/{PutCourseVersionModule.md → PutCourseVersionSection.md} +4 -6
  85. package/docs/ReportingApi.md +22 -22
  86. package/package.json +1 -1
  87. package/src/apis/CourseApi.ts +160 -234
  88. package/src/apis/ReportingApi.ts +40 -40
  89. package/src/models/GetCourseExport.ts +5 -5
  90. package/src/models/GetCourseVersion.ts +12 -12
  91. package/src/models/GetCourseVersionReporting.ts +11 -11
  92. package/src/models/{GetCourseVersionModule.ts → GetCourseVersionSection.ts} +28 -28
  93. package/src/models/GetCourseVersionSectionChild.ts +108 -0
  94. package/src/models/{GetCourseVersionModuleReporting.ts → GetCourseVersionSectionReporting.ts} +26 -26
  95. package/src/models/GetPermission.ts +1 -1
  96. package/src/models/PostCourseExport.ts +5 -5
  97. package/src/models/PostCourseResume.ts +4 -4
  98. package/src/models/{PostCourseVersionModule.ts → PostCourseVersionSection.ts} +22 -14
  99. package/src/models/PostCourseVersionSectionDuplicate.ts +81 -0
  100. package/src/models/PutCourseVersionItem.ts +3 -3
  101. package/src/models/PutCourseVersionOutlineEntryMove.ts +103 -0
  102. package/src/models/{PutCourseVersionModule.ts → PutCourseVersionSection.ts} +13 -21
  103. package/src/models/PutRolePermissions.ts +1 -1
  104. package/src/models/index.ts +7 -7
  105. package/dist/esm/models/GetCourseVersionModule.d.ts +0 -64
  106. package/dist/esm/models/GetCourseVersionModuleReporting.d.ts +0 -99
  107. package/dist/esm/models/PostCourseVersionModule.d.ts +0 -51
  108. package/dist/esm/models/PostCourseVersionModuleDuplicate.d.ts +0 -38
  109. package/dist/esm/models/PostCourseVersionModuleDuplicate.js +0 -43
  110. package/dist/esm/models/PutCourseVersionItemReorder.d.ts +0 -32
  111. package/dist/esm/models/PutCourseVersionItemReorder.js +0 -43
  112. package/dist/esm/models/PutCourseVersionModule.d.ts +0 -51
  113. package/dist/esm/models/PutCourseVersionModuleReorder.d.ts +0 -32
  114. package/dist/esm/models/PutCourseVersionModuleReorder.js +0 -43
  115. package/dist/models/GetCourseVersionModule.d.ts +0 -64
  116. package/dist/models/GetCourseVersionModuleReporting.d.ts +0 -99
  117. package/dist/models/PostCourseVersionModule.d.ts +0 -51
  118. package/dist/models/PostCourseVersionModuleDuplicate.d.ts +0 -38
  119. package/dist/models/PostCourseVersionModuleDuplicate.js +0 -50
  120. package/dist/models/PutCourseVersionItemReorder.d.ts +0 -32
  121. package/dist/models/PutCourseVersionItemReorder.js +0 -50
  122. package/dist/models/PutCourseVersionModule.d.ts +0 -51
  123. package/dist/models/PutCourseVersionModuleReorder.d.ts +0 -32
  124. package/dist/models/PutCourseVersionModuleReorder.js +0 -50
  125. package/src/models/PostCourseVersionModuleDuplicate.ts +0 -73
  126. package/src/models/PutCourseVersionItemReorder.ts +0 -66
  127. package/src/models/PutCourseVersionModuleReorder.ts +0 -66
@@ -10,33 +10,21 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { type GetCourseVersionModuleReporting } from '../models/GetCourseVersionModuleReporting';
14
13
  import { type GetCourseVersionReporting } from '../models/GetCourseVersionReporting';
15
- export interface GetCourseVersionModuleReportingRequest {
14
+ import { type GetCourseVersionSectionReporting } from '../models/GetCourseVersionSectionReporting';
15
+ export interface GetCourseVersionReportingRequest {
16
16
  courseId: string;
17
17
  courseVersionId: string;
18
- moduleId: string;
19
18
  }
20
- export interface GetCourseVersionReportingRequest {
19
+ export interface GetCourseVersionSectionReportingRequest {
21
20
  courseId: string;
22
21
  courseVersionId: string;
22
+ sectionId: string;
23
23
  }
24
24
  /**
25
25
  *
26
26
  */
27
27
  export declare class ReportingApi extends runtime.BaseAPI {
28
- /**
29
- * Creates request options for getCourseVersionModuleReporting without sending the request
30
- */
31
- getCourseVersionModuleReportingRequestOpts(requestParameters: GetCourseVersionModuleReportingRequest): Promise<runtime.RequestOpts>;
32
- /**
33
- * Get instructor reporting for one module in an explicit course version
34
- */
35
- getCourseVersionModuleReportingRaw(requestParameters: GetCourseVersionModuleReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersionModuleReporting>>;
36
- /**
37
- * Get instructor reporting for one module in an explicit course version
38
- */
39
- getCourseVersionModuleReporting(requestParameters: GetCourseVersionModuleReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionModuleReporting>;
40
28
  /**
41
29
  * Creates request options for getCourseVersionReporting without sending the request
42
30
  */
@@ -49,4 +37,16 @@ export declare class ReportingApi extends runtime.BaseAPI {
49
37
  * Get instructor reporting for one explicit course version
50
38
  */
51
39
  getCourseVersionReporting(requestParameters: GetCourseVersionReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionReporting>;
40
+ /**
41
+ * Creates request options for getCourseVersionSectionReporting without sending the request
42
+ */
43
+ getCourseVersionSectionReportingRequestOpts(requestParameters: GetCourseVersionSectionReportingRequest): Promise<runtime.RequestOpts>;
44
+ /**
45
+ * Get instructor reporting for one section and its descendants in an explicit course version
46
+ */
47
+ getCourseVersionSectionReportingRaw(requestParameters: GetCourseVersionSectionReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersionSectionReporting>>;
48
+ /**
49
+ * Get instructor reporting for one section and its descendants in an explicit course version
50
+ */
51
+ getCourseVersionSectionReporting(requestParameters: GetCourseVersionSectionReportingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionSectionReporting>;
52
52
  }
@@ -21,32 +21,28 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { GetCourseVersionModuleReportingFromJSON, } from '../models/GetCourseVersionModuleReporting';
25
24
  import { GetCourseVersionReportingFromJSON, } from '../models/GetCourseVersionReporting';
25
+ import { GetCourseVersionSectionReportingFromJSON, } from '../models/GetCourseVersionSectionReporting';
26
26
  /**
27
27
  *
28
28
  */
29
29
  export class ReportingApi extends runtime.BaseAPI {
30
30
  /**
31
- * Creates request options for getCourseVersionModuleReporting without sending the request
31
+ * Creates request options for getCourseVersionReporting without sending the request
32
32
  */
33
- getCourseVersionModuleReportingRequestOpts(requestParameters) {
33
+ getCourseVersionReportingRequestOpts(requestParameters) {
34
34
  return __awaiter(this, void 0, void 0, function* () {
35
35
  if (requestParameters['courseId'] == null) {
36
- throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseVersionModuleReporting().');
36
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseVersionReporting().');
37
37
  }
38
38
  if (requestParameters['courseVersionId'] == null) {
39
- throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionModuleReporting().');
40
- }
41
- if (requestParameters['moduleId'] == null) {
42
- throw new runtime.RequiredError('moduleId', 'Required parameter "moduleId" was null or undefined when calling getCourseVersionModuleReporting().');
39
+ throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionReporting().');
43
40
  }
44
41
  const queryParameters = {};
45
42
  const headerParameters = {};
46
- let urlPath = `/courses/{courseId}/versions/{courseVersionId}/modules/{moduleId}/reporting`;
43
+ let urlPath = `/courses/{courseId}/versions/{courseVersionId}/reporting`;
47
44
  urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
48
45
  urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
49
- urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
50
46
  return {
51
47
  path: urlPath,
52
48
  method: 'GET',
@@ -56,40 +52,44 @@ export class ReportingApi extends runtime.BaseAPI {
56
52
  });
57
53
  }
58
54
  /**
59
- * Get instructor reporting for one module in an explicit course version
55
+ * Get instructor reporting for one explicit course version
60
56
  */
61
- getCourseVersionModuleReportingRaw(requestParameters, initOverrides) {
57
+ getCourseVersionReportingRaw(requestParameters, initOverrides) {
62
58
  return __awaiter(this, void 0, void 0, function* () {
63
- const requestOptions = yield this.getCourseVersionModuleReportingRequestOpts(requestParameters);
59
+ const requestOptions = yield this.getCourseVersionReportingRequestOpts(requestParameters);
64
60
  const response = yield this.request(requestOptions, initOverrides);
65
- return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseVersionModuleReportingFromJSON(jsonValue));
61
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseVersionReportingFromJSON(jsonValue));
66
62
  });
67
63
  }
68
64
  /**
69
- * Get instructor reporting for one module in an explicit course version
65
+ * Get instructor reporting for one explicit course version
70
66
  */
71
- getCourseVersionModuleReporting(requestParameters, initOverrides) {
67
+ getCourseVersionReporting(requestParameters, initOverrides) {
72
68
  return __awaiter(this, void 0, void 0, function* () {
73
- const response = yield this.getCourseVersionModuleReportingRaw(requestParameters, initOverrides);
69
+ const response = yield this.getCourseVersionReportingRaw(requestParameters, initOverrides);
74
70
  return yield response.value();
75
71
  });
76
72
  }
77
73
  /**
78
- * Creates request options for getCourseVersionReporting without sending the request
74
+ * Creates request options for getCourseVersionSectionReporting without sending the request
79
75
  */
80
- getCourseVersionReportingRequestOpts(requestParameters) {
76
+ getCourseVersionSectionReportingRequestOpts(requestParameters) {
81
77
  return __awaiter(this, void 0, void 0, function* () {
82
78
  if (requestParameters['courseId'] == null) {
83
- throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseVersionReporting().');
79
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseVersionSectionReporting().');
84
80
  }
85
81
  if (requestParameters['courseVersionId'] == null) {
86
- throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionReporting().');
82
+ throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionSectionReporting().');
83
+ }
84
+ if (requestParameters['sectionId'] == null) {
85
+ throw new runtime.RequiredError('sectionId', 'Required parameter "sectionId" was null or undefined when calling getCourseVersionSectionReporting().');
87
86
  }
88
87
  const queryParameters = {};
89
88
  const headerParameters = {};
90
- let urlPath = `/courses/{courseId}/versions/{courseVersionId}/reporting`;
89
+ let urlPath = `/courses/{courseId}/versions/{courseVersionId}/sections/{sectionId}/reporting`;
91
90
  urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
92
91
  urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
92
+ urlPath = urlPath.replace('{sectionId}', encodeURIComponent(String(requestParameters['sectionId'])));
93
93
  return {
94
94
  path: urlPath,
95
95
  method: 'GET',
@@ -99,21 +99,21 @@ export class ReportingApi extends runtime.BaseAPI {
99
99
  });
100
100
  }
101
101
  /**
102
- * Get instructor reporting for one explicit course version
102
+ * Get instructor reporting for one section and its descendants in an explicit course version
103
103
  */
104
- getCourseVersionReportingRaw(requestParameters, initOverrides) {
104
+ getCourseVersionSectionReportingRaw(requestParameters, initOverrides) {
105
105
  return __awaiter(this, void 0, void 0, function* () {
106
- const requestOptions = yield this.getCourseVersionReportingRequestOpts(requestParameters);
106
+ const requestOptions = yield this.getCourseVersionSectionReportingRequestOpts(requestParameters);
107
107
  const response = yield this.request(requestOptions, initOverrides);
108
- return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseVersionReportingFromJSON(jsonValue));
108
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseVersionSectionReportingFromJSON(jsonValue));
109
109
  });
110
110
  }
111
111
  /**
112
- * Get instructor reporting for one explicit course version
112
+ * Get instructor reporting for one section and its descendants in an explicit course version
113
113
  */
114
- getCourseVersionReporting(requestParameters, initOverrides) {
114
+ getCourseVersionSectionReporting(requestParameters, initOverrides) {
115
115
  return __awaiter(this, void 0, void 0, function* () {
116
- const response = yield this.getCourseVersionReportingRaw(requestParameters, initOverrides);
116
+ const response = yield this.getCourseVersionSectionReportingRaw(requestParameters, initOverrides);
117
117
  return yield response.value();
118
118
  });
119
119
  }
@@ -40,11 +40,11 @@ export interface GetCourseExport {
40
40
  */
41
41
  exportType: GetCourseExportExportTypeEnum;
42
42
  /**
43
- * IDs of the modules included in the export
43
+ * IDs of the root sections included in the export
44
44
  * @type {Array<string>}
45
45
  * @memberof GetCourseExport
46
46
  */
47
- moduleIds: Array<string>;
47
+ sectionIds: Array<string>;
48
48
  /**
49
49
  * ID of the user who requested the export
50
50
  * @type {number}
@@ -38,7 +38,7 @@ export function instanceOfGetCourseExport(value) {
38
38
  return false;
39
39
  if (!('exportType' in value) || value['exportType'] === undefined)
40
40
  return false;
41
- if (!('moduleIds' in value) || value['moduleIds'] === undefined)
41
+ if (!('sectionIds' in value) || value['sectionIds'] === undefined)
42
42
  return false;
43
43
  if (!('createdBy' in value) || value['createdBy'] === undefined)
44
44
  return false;
@@ -60,7 +60,7 @@ export function GetCourseExportFromJSONTyped(json, ignoreDiscriminator) {
60
60
  'courseId': json['course_id'],
61
61
  'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
62
62
  'exportType': json['export_type'],
63
- 'moduleIds': json['module_ids'],
63
+ 'sectionIds': json['section_ids'],
64
64
  'createdBy': json['created_by'],
65
65
  'status': json['status'],
66
66
  'downloadUrl': json['download_url'] == null ? undefined : json['download_url'],
@@ -81,7 +81,7 @@ export function GetCourseExportToJSONTyped(value, ignoreDiscriminator = false) {
81
81
  'course_id': value['courseId'],
82
82
  'course_version_id': value['courseVersionId'],
83
83
  'export_type': value['exportType'],
84
- 'module_ids': value['moduleIds'],
84
+ 'section_ids': value['sectionIds'],
85
85
  'created_by': value['createdBy'],
86
86
  'status': value['status'],
87
87
  'download_url': value['downloadUrl'],
@@ -9,9 +9,9 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { GetCourseVersionModule } from './GetCourseVersionModule';
13
12
  import type { ContentLibraryVersionStatus } from './ContentLibraryVersionStatus';
14
13
  import type { RichTextDocument } from './RichTextDocument';
14
+ import type { GetCourseVersionSection } from './GetCourseVersionSection';
15
15
  /**
16
16
  *
17
17
  * @export
@@ -68,10 +68,10 @@ export interface GetCourseVersion {
68
68
  changeNotes?: string | null;
69
69
  /**
70
70
  *
71
- * @type {Array<GetCourseVersionModule>}
71
+ * @type {Array<GetCourseVersionSection>}
72
72
  * @memberof GetCourseVersion
73
73
  */
74
- modules: Array<GetCourseVersionModule>;
74
+ sections: Array<GetCourseVersionSection>;
75
75
  /**
76
76
  *
77
77
  * @type {number}
@@ -11,9 +11,9 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- import { GetCourseVersionModuleFromJSON, GetCourseVersionModuleToJSON, } from './GetCourseVersionModule';
15
14
  import { ContentLibraryVersionStatusFromJSON, ContentLibraryVersionStatusToJSON, } from './ContentLibraryVersionStatus';
16
15
  import { RichTextDocumentFromJSON, RichTextDocumentToJSON, } from './RichTextDocument';
16
+ import { GetCourseVersionSectionFromJSON, GetCourseVersionSectionToJSON, } from './GetCourseVersionSection';
17
17
  /**
18
18
  * Check if a given object implements the GetCourseVersion interface.
19
19
  */
@@ -32,7 +32,7 @@ export function instanceOfGetCourseVersion(value) {
32
32
  return false;
33
33
  if (!('descriptionRich' in value) || value['descriptionRich'] === undefined)
34
34
  return false;
35
- if (!('modules' in value) || value['modules'] === undefined)
35
+ if (!('sections' in value) || value['sections'] === undefined)
36
36
  return false;
37
37
  if (!('createdAt' in value) || value['createdAt'] === undefined)
38
38
  return false;
@@ -56,7 +56,7 @@ export function GetCourseVersionFromJSONTyped(json, ignoreDiscriminator) {
56
56
  'description': json['description'],
57
57
  'descriptionRich': RichTextDocumentFromJSON(json['description_rich']),
58
58
  'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
59
- 'modules': (json['modules'].map(GetCourseVersionModuleFromJSON)),
59
+ 'sections': (json['sections'].map(GetCourseVersionSectionFromJSON)),
60
60
  'createdAt': json['created_at'],
61
61
  'updatedAt': json['updated_at'],
62
62
  'publishedAt': json['published_at'] == null ? undefined : json['published_at'],
@@ -78,7 +78,7 @@ export function GetCourseVersionToJSONTyped(value, ignoreDiscriminator = false)
78
78
  'description': value['description'],
79
79
  'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
80
80
  'change_notes': value['changeNotes'],
81
- 'modules': (value['modules'].map(GetCourseVersionModuleToJSON)),
81
+ 'sections': (value['sections'].map(GetCourseVersionSectionToJSON)),
82
82
  'created_at': value['createdAt'],
83
83
  'updated_at': value['updatedAt'],
84
84
  'published_at': value['publishedAt'],
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { GetCourseVersionModuleReporting } from './GetCourseVersionModuleReporting';
12
+ import type { GetCourseVersionSectionReporting } from './GetCourseVersionSectionReporting';
13
13
  /**
14
14
  *
15
15
  * @export
@@ -78,10 +78,10 @@ export interface GetCourseVersionReporting {
78
78
  totalDurationSeconds: number;
79
79
  /**
80
80
  *
81
- * @type {Array<GetCourseVersionModuleReporting>}
81
+ * @type {Array<GetCourseVersionSectionReporting>}
82
82
  * @memberof GetCourseVersionReporting
83
83
  */
84
- modules: Array<GetCourseVersionModuleReporting>;
84
+ sections: Array<GetCourseVersionSectionReporting>;
85
85
  }
86
86
  /**
87
87
  * Check if a given object implements the GetCourseVersionReporting interface.
@@ -11,7 +11,7 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- import { GetCourseVersionModuleReportingFromJSON, GetCourseVersionModuleReportingToJSON, } from './GetCourseVersionModuleReporting';
14
+ import { GetCourseVersionSectionReportingFromJSON, GetCourseVersionSectionReportingToJSON, } from './GetCourseVersionSectionReporting';
15
15
  /**
16
16
  * Check if a given object implements the GetCourseVersionReporting interface.
17
17
  */
@@ -36,7 +36,7 @@ export function instanceOfGetCourseVersionReporting(value) {
36
36
  return false;
37
37
  if (!('totalDurationSeconds' in value) || value['totalDurationSeconds'] === undefined)
38
38
  return false;
39
- if (!('modules' in value) || value['modules'] === undefined)
39
+ if (!('sections' in value) || value['sections'] === undefined)
40
40
  return false;
41
41
  return true;
42
42
  }
@@ -58,7 +58,7 @@ export function GetCourseVersionReportingFromJSONTyped(json, ignoreDiscriminator
58
58
  'completionRatePercentage': json['completion_rate_percentage'],
59
59
  'avgScorePercentage': json['avg_score_percentage'],
60
60
  'totalDurationSeconds': json['total_duration_seconds'],
61
- 'modules': (json['modules'].map(GetCourseVersionModuleReportingFromJSON)),
61
+ 'sections': (json['sections'].map(GetCourseVersionSectionReportingFromJSON)),
62
62
  };
63
63
  }
64
64
  export function GetCourseVersionReportingToJSON(json) {
@@ -79,6 +79,6 @@ export function GetCourseVersionReportingToJSONTyped(value, ignoreDiscriminator
79
79
  'completion_rate_percentage': value['completionRatePercentage'],
80
80
  'avg_score_percentage': value['avgScorePercentage'],
81
81
  'total_duration_seconds': value['totalDurationSeconds'],
82
- 'modules': (value['modules'].map(GetCourseVersionModuleReportingToJSON)),
82
+ 'sections': (value['sections'].map(GetCourseVersionSectionReportingToJSON)),
83
83
  };
84
84
  }
@@ -0,0 +1,64 @@
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
+ import type { GetCourseVersionSectionChild } from './GetCourseVersionSectionChild';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface GetCourseVersionSection
18
+ */
19
+ export interface GetCourseVersionSection {
20
+ /**
21
+ *
22
+ * @type {string}
23
+ * @memberof GetCourseVersionSection
24
+ */
25
+ id: string;
26
+ /**
27
+ *
28
+ * @type {string}
29
+ * @memberof GetCourseVersionSection
30
+ */
31
+ name: string;
32
+ /**
33
+ *
34
+ * @type {string}
35
+ * @memberof GetCourseVersionSection
36
+ */
37
+ description: string;
38
+ /**
39
+ *
40
+ * @type {RichTextDocument}
41
+ * @memberof GetCourseVersionSection
42
+ */
43
+ descriptionRich: RichTextDocument;
44
+ /**
45
+ *
46
+ * @type {number}
47
+ * @memberof GetCourseVersionSection
48
+ */
49
+ displayOrder: number;
50
+ /**
51
+ *
52
+ * @type {Array<GetCourseVersionSectionChild>}
53
+ * @memberof GetCourseVersionSection
54
+ */
55
+ children: Array<GetCourseVersionSectionChild>;
56
+ }
57
+ /**
58
+ * Check if a given object implements the GetCourseVersionSection interface.
59
+ */
60
+ export declare function instanceOfGetCourseVersionSection(value: object): value is GetCourseVersionSection;
61
+ export declare function GetCourseVersionSectionFromJSON(json: any): GetCourseVersionSection;
62
+ export declare function GetCourseVersionSectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionSection;
63
+ export declare function GetCourseVersionSectionToJSON(json: any): GetCourseVersionSection;
64
+ export declare function GetCourseVersionSectionToJSONTyped(value?: GetCourseVersionSection | null, ignoreDiscriminator?: boolean): any;
@@ -11,12 +11,12 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- import { GetCourseVersionItemFromJSON, GetCourseVersionItemToJSON, } from './GetCourseVersionItem';
15
14
  import { RichTextDocumentFromJSON, RichTextDocumentToJSON, } from './RichTextDocument';
15
+ import { GetCourseVersionSectionChildFromJSON, GetCourseVersionSectionChildToJSON, } from './GetCourseVersionSectionChild';
16
16
  /**
17
- * Check if a given object implements the GetCourseVersionModule interface.
17
+ * Check if a given object implements the GetCourseVersionSection interface.
18
18
  */
19
- export function instanceOfGetCourseVersionModule(value) {
19
+ export function instanceOfGetCourseVersionSection(value) {
20
20
  if (!('id' in value) || value['id'] === undefined)
21
21
  return false;
22
22
  if (!('name' in value) || value['name'] === undefined)
@@ -27,14 +27,14 @@ export function instanceOfGetCourseVersionModule(value) {
27
27
  return false;
28
28
  if (!('displayOrder' in value) || value['displayOrder'] === undefined)
29
29
  return false;
30
- if (!('items' in value) || value['items'] === undefined)
30
+ if (!('children' in value) || value['children'] === undefined)
31
31
  return false;
32
32
  return true;
33
33
  }
34
- export function GetCourseVersionModuleFromJSON(json) {
35
- return GetCourseVersionModuleFromJSONTyped(json, false);
34
+ export function GetCourseVersionSectionFromJSON(json) {
35
+ return GetCourseVersionSectionFromJSONTyped(json, false);
36
36
  }
37
- export function GetCourseVersionModuleFromJSONTyped(json, ignoreDiscriminator) {
37
+ export function GetCourseVersionSectionFromJSONTyped(json, ignoreDiscriminator) {
38
38
  if (json == null) {
39
39
  return json;
40
40
  }
@@ -44,13 +44,13 @@ export function GetCourseVersionModuleFromJSONTyped(json, ignoreDiscriminator) {
44
44
  'description': json['description'],
45
45
  'descriptionRich': RichTextDocumentFromJSON(json['description_rich']),
46
46
  'displayOrder': json['display_order'],
47
- 'items': (json['items'].map(GetCourseVersionItemFromJSON)),
47
+ 'children': (json['children'].map(GetCourseVersionSectionChildFromJSON)),
48
48
  };
49
49
  }
50
- export function GetCourseVersionModuleToJSON(json) {
51
- return GetCourseVersionModuleToJSONTyped(json, false);
50
+ export function GetCourseVersionSectionToJSON(json) {
51
+ return GetCourseVersionSectionToJSONTyped(json, false);
52
52
  }
53
- export function GetCourseVersionModuleToJSONTyped(value, ignoreDiscriminator = false) {
53
+ export function GetCourseVersionSectionToJSONTyped(value, ignoreDiscriminator = false) {
54
54
  if (value == null) {
55
55
  return value;
56
56
  }
@@ -60,6 +60,6 @@ export function GetCourseVersionModuleToJSONTyped(value, ignoreDiscriminator = f
60
60
  'description': value['description'],
61
61
  'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
62
62
  'display_order': value['displayOrder'],
63
- 'items': (value['items'].map(GetCourseVersionItemToJSON)),
63
+ 'children': (value['children'].map(GetCourseVersionSectionChildToJSON)),
64
64
  };
65
65
  }
@@ -0,0 +1,54 @@
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 { GetCourseVersionItem } from './GetCourseVersionItem';
13
+ import type { GetCourseVersionSection } from './GetCourseVersionSection';
14
+ /**
15
+ * An ordered child entry containing exactly one section or course item.
16
+ * @export
17
+ * @interface GetCourseVersionSectionChild
18
+ */
19
+ export interface GetCourseVersionSectionChild {
20
+ /**
21
+ *
22
+ * @type {GetCourseVersionSectionChildKindEnum}
23
+ * @memberof GetCourseVersionSectionChild
24
+ */
25
+ kind: GetCourseVersionSectionChildKindEnum;
26
+ /**
27
+ *
28
+ * @type {GetCourseVersionSection}
29
+ * @memberof GetCourseVersionSectionChild
30
+ */
31
+ section?: GetCourseVersionSection | null;
32
+ /**
33
+ *
34
+ * @type {GetCourseVersionItem}
35
+ * @memberof GetCourseVersionSectionChild
36
+ */
37
+ item?: GetCourseVersionItem | null;
38
+ }
39
+ /**
40
+ * @export
41
+ */
42
+ export declare const GetCourseVersionSectionChildKindEnum: {
43
+ readonly Section: "section";
44
+ readonly Item: "item";
45
+ };
46
+ export type GetCourseVersionSectionChildKindEnum = typeof GetCourseVersionSectionChildKindEnum[keyof typeof GetCourseVersionSectionChildKindEnum];
47
+ /**
48
+ * Check if a given object implements the GetCourseVersionSectionChild interface.
49
+ */
50
+ export declare function instanceOfGetCourseVersionSectionChild(value: object): value is GetCourseVersionSectionChild;
51
+ export declare function GetCourseVersionSectionChildFromJSON(json: any): GetCourseVersionSectionChild;
52
+ export declare function GetCourseVersionSectionChildFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionSectionChild;
53
+ export declare function GetCourseVersionSectionChildToJSON(json: any): GetCourseVersionSectionChild;
54
+ export declare function GetCourseVersionSectionChildToJSONTyped(value?: GetCourseVersionSectionChild | null, ignoreDiscriminator?: boolean): any;
@@ -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
+ }