@easyedu/js-lsm-api 1.68.0 → 1.70.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 (56) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +6 -2
  3. package/dist/esm/models/ContentAttemptSettings.d.ts +46 -0
  4. package/dist/esm/models/ContentAttemptSettings.js +54 -0
  5. package/dist/esm/models/GetContent.d.ts +7 -0
  6. package/dist/esm/models/GetContent.js +5 -0
  7. package/dist/esm/models/GetCourseStudentReporting.d.ts +7 -0
  8. package/dist/esm/models/GetCourseStudentReporting.js +5 -0
  9. package/dist/esm/models/GetCourseStudentReportingModulesInner.d.ts +71 -0
  10. package/dist/esm/models/GetCourseStudentReportingModulesInner.js +71 -0
  11. package/dist/esm/models/GetModuleStudentReporting.d.ts +7 -0
  12. package/dist/esm/models/GetModuleStudentReporting.js +5 -0
  13. package/dist/esm/models/GetModuleStudentReportingContentsInner.d.ts +101 -0
  14. package/dist/esm/models/GetModuleStudentReportingContentsInner.js +91 -0
  15. package/dist/esm/models/PutContent.d.ts +7 -0
  16. package/dist/esm/models/PutContent.js +3 -0
  17. package/dist/esm/models/PutContentAttemptSettings.d.ts +46 -0
  18. package/dist/esm/models/PutContentAttemptSettings.js +50 -0
  19. package/dist/esm/models/index.d.ts +4 -0
  20. package/dist/esm/models/index.js +4 -0
  21. package/dist/models/ContentAttemptSettings.d.ts +46 -0
  22. package/dist/models/ContentAttemptSettings.js +62 -0
  23. package/dist/models/GetContent.d.ts +7 -0
  24. package/dist/models/GetContent.js +5 -0
  25. package/dist/models/GetCourseStudentReporting.d.ts +7 -0
  26. package/dist/models/GetCourseStudentReporting.js +5 -0
  27. package/dist/models/GetCourseStudentReportingModulesInner.d.ts +71 -0
  28. package/dist/models/GetCourseStudentReportingModulesInner.js +79 -0
  29. package/dist/models/GetModuleStudentReporting.d.ts +7 -0
  30. package/dist/models/GetModuleStudentReporting.js +5 -0
  31. package/dist/models/GetModuleStudentReportingContentsInner.d.ts +101 -0
  32. package/dist/models/GetModuleStudentReportingContentsInner.js +99 -0
  33. package/dist/models/PutContent.d.ts +7 -0
  34. package/dist/models/PutContent.js +3 -0
  35. package/dist/models/PutContentAttemptSettings.d.ts +46 -0
  36. package/dist/models/PutContentAttemptSettings.js +58 -0
  37. package/dist/models/index.d.ts +4 -0
  38. package/dist/models/index.js +4 -0
  39. package/docs/ContentAttemptSettings.md +36 -0
  40. package/docs/GetContent.md +2 -0
  41. package/docs/GetCourseStudentReporting.md +2 -0
  42. package/docs/GetCourseStudentReportingModulesInner.md +44 -0
  43. package/docs/GetModuleStudentReporting.md +2 -0
  44. package/docs/GetModuleStudentReportingContentsInner.md +54 -0
  45. package/docs/PutContent.md +2 -0
  46. package/docs/PutContentAttemptSettings.md +36 -0
  47. package/package.json +1 -1
  48. package/src/models/ContentAttemptSettings.ts +86 -0
  49. package/src/models/GetContent.ts +16 -0
  50. package/src/models/GetCourseStudentReporting.ts +16 -0
  51. package/src/models/GetCourseStudentReportingModulesInner.ts +123 -0
  52. package/src/models/GetModuleStudentReporting.ts +16 -0
  53. package/src/models/GetModuleStudentReportingContentsInner.ts +168 -0
  54. package/src/models/PutContent.ts +15 -0
  55. package/src/models/PutContentAttemptSettings.ts +84 -0
  56. package/src/models/index.ts +4 -0
@@ -11,6 +11,7 @@ docs/ContentApi.md
11
11
  docs/ContentAttemptItem.md
12
12
  docs/ContentAttemptRollupScore.md
13
13
  docs/ContentAttemptScore.md
14
+ docs/ContentAttemptSettings.md
14
15
  docs/ContentLaunchMode.md
15
16
  docs/CourseApi.md
16
17
  docs/CourseCatalog.md
@@ -68,6 +69,7 @@ docs/GetCourseReportingBasic.md
68
69
  docs/GetCourseStudentReporting.md
69
70
  docs/GetCourseStudentReportingCourseInfo.md
70
71
  docs/GetCourseStudentReportingEngagement.md
72
+ docs/GetCourseStudentReportingModulesInner.md
71
73
  docs/GetCourseStudentReportingPerformance.md
72
74
  docs/GetManualQuestionSelectionItem.md
73
75
  docs/GetManualQuestionSelectionList.md
@@ -79,6 +81,7 @@ docs/GetModuleInstructorBasicReportingPerformance.md
79
81
  docs/GetModuleList.md
80
82
  docs/GetModuleStudentReporting.md
81
83
  docs/GetModuleStudentReportingAccess.md
84
+ docs/GetModuleStudentReportingContentsInner.md
82
85
  docs/GetModuleStudentReportingProgress.md
83
86
  docs/GetPermission.md
84
87
  docs/GetPortal.md
@@ -239,6 +242,7 @@ docs/PostVerifyManifestItemsInner.md
239
242
  docs/PostVerifyManifestResourcesInner.md
240
243
  docs/PutCertificateConfig.md
241
244
  docs/PutContent.md
245
+ docs/PutContentAttemptSettings.md
242
246
  docs/PutContentReorder.md
243
247
  docs/PutContentVersion.md
244
248
  docs/PutCourse.md
@@ -312,6 +316,7 @@ src/models/CertificatePublic.ts
312
316
  src/models/ContentAttemptItem.ts
313
317
  src/models/ContentAttemptRollupScore.ts
314
318
  src/models/ContentAttemptScore.ts
319
+ src/models/ContentAttemptSettings.ts
315
320
  src/models/ContentLaunchMode.ts
316
321
  src/models/CourseCatalog.ts
317
322
  src/models/CourseShare.ts
@@ -365,6 +370,7 @@ src/models/GetCourseReportingBasic.ts
365
370
  src/models/GetCourseStudentReporting.ts
366
371
  src/models/GetCourseStudentReportingCourseInfo.ts
367
372
  src/models/GetCourseStudentReportingEngagement.ts
373
+ src/models/GetCourseStudentReportingModulesInner.ts
368
374
  src/models/GetCourseStudentReportingPerformance.ts
369
375
  src/models/GetManualQuestionSelectionItem.ts
370
376
  src/models/GetManualQuestionSelectionList.ts
@@ -376,6 +382,7 @@ src/models/GetModuleInstructorBasicReportingPerformance.ts
376
382
  src/models/GetModuleList.ts
377
383
  src/models/GetModuleStudentReporting.ts
378
384
  src/models/GetModuleStudentReportingAccess.ts
385
+ src/models/GetModuleStudentReportingContentsInner.ts
379
386
  src/models/GetModuleStudentReportingProgress.ts
380
387
  src/models/GetPermission.ts
381
388
  src/models/GetPortal.ts
@@ -531,6 +538,7 @@ src/models/PostVerifyManifestItemsInner.ts
531
538
  src/models/PostVerifyManifestResourcesInner.ts
532
539
  src/models/PutCertificateConfig.ts
533
540
  src/models/PutContent.ts
541
+ src/models/PutContentAttemptSettings.ts
534
542
  src/models/PutContentReorder.ts
535
543
  src/models/PutContentVersion.ts
536
544
  src/models/PutCourse.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @easyedu/js-lsm-api@1.68.0
1
+ # @easyedu/js-lsm-api@1.70.0
2
2
 
3
3
  A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
4
4
 
@@ -253,6 +253,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
253
253
  - [ContentAttemptItem](docs/ContentAttemptItem.md)
254
254
  - [ContentAttemptRollupScore](docs/ContentAttemptRollupScore.md)
255
255
  - [ContentAttemptScore](docs/ContentAttemptScore.md)
256
+ - [ContentAttemptSettings](docs/ContentAttemptSettings.md)
256
257
  - [ContentLaunchMode](docs/ContentLaunchMode.md)
257
258
  - [CourseCatalog](docs/CourseCatalog.md)
258
259
  - [CourseShare](docs/CourseShare.md)
@@ -306,6 +307,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
306
307
  - [GetCourseStudentReporting](docs/GetCourseStudentReporting.md)
307
308
  - [GetCourseStudentReportingCourseInfo](docs/GetCourseStudentReportingCourseInfo.md)
308
309
  - [GetCourseStudentReportingEngagement](docs/GetCourseStudentReportingEngagement.md)
310
+ - [GetCourseStudentReportingModulesInner](docs/GetCourseStudentReportingModulesInner.md)
309
311
  - [GetCourseStudentReportingPerformance](docs/GetCourseStudentReportingPerformance.md)
310
312
  - [GetManualQuestionSelectionItem](docs/GetManualQuestionSelectionItem.md)
311
313
  - [GetManualQuestionSelectionList](docs/GetManualQuestionSelectionList.md)
@@ -317,6 +319,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
317
319
  - [GetModuleList](docs/GetModuleList.md)
318
320
  - [GetModuleStudentReporting](docs/GetModuleStudentReporting.md)
319
321
  - [GetModuleStudentReportingAccess](docs/GetModuleStudentReportingAccess.md)
322
+ - [GetModuleStudentReportingContentsInner](docs/GetModuleStudentReportingContentsInner.md)
320
323
  - [GetModuleStudentReportingProgress](docs/GetModuleStudentReportingProgress.md)
321
324
  - [GetPermission](docs/GetPermission.md)
322
325
  - [GetPortal](docs/GetPortal.md)
@@ -472,6 +475,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
472
475
  - [PostVerifyManifestResourcesInner](docs/PostVerifyManifestResourcesInner.md)
473
476
  - [PutCertificateConfig](docs/PutCertificateConfig.md)
474
477
  - [PutContent](docs/PutContent.md)
478
+ - [PutContentAttemptSettings](docs/PutContentAttemptSettings.md)
475
479
  - [PutContentReorder](docs/PutContentReorder.md)
476
480
  - [PutContentVersion](docs/PutContentVersion.md)
477
481
  - [PutCourse](docs/PutCourse.md)
@@ -525,7 +529,7 @@ and is automatically generated by the
525
529
  [OpenAPI Generator](https://openapi-generator.tech) project:
526
530
 
527
531
  - API version: `1.0.0`
528
- - Package version: `1.68.0`
532
+ - Package version: `1.70.0`
529
533
  - Generator version: `7.22.0`
530
534
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
531
535
 
@@ -0,0 +1,46 @@
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 ContentAttemptSettings
16
+ */
17
+ export interface ContentAttemptSettings {
18
+ /**
19
+ * Maximum allowed attempts for this content
20
+ * @type {number}
21
+ * @memberof ContentAttemptSettings
22
+ */
23
+ maxAttempts: number;
24
+ /**
25
+ * Strategy used to calculate the content rollup score
26
+ * @type {ContentAttemptSettingsScoreRollupStrategyEnum}
27
+ * @memberof ContentAttemptSettings
28
+ */
29
+ scoreRollupStrategy: ContentAttemptSettingsScoreRollupStrategyEnum;
30
+ }
31
+ /**
32
+ * @export
33
+ */
34
+ export declare const ContentAttemptSettingsScoreRollupStrategyEnum: {
35
+ readonly Latest: "Latest";
36
+ readonly Best: "Best";
37
+ };
38
+ export type ContentAttemptSettingsScoreRollupStrategyEnum = typeof ContentAttemptSettingsScoreRollupStrategyEnum[keyof typeof ContentAttemptSettingsScoreRollupStrategyEnum];
39
+ /**
40
+ * Check if a given object implements the ContentAttemptSettings interface.
41
+ */
42
+ export declare function instanceOfContentAttemptSettings(value: object): value is ContentAttemptSettings;
43
+ export declare function ContentAttemptSettingsFromJSON(json: any): ContentAttemptSettings;
44
+ export declare function ContentAttemptSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentAttemptSettings;
45
+ export declare function ContentAttemptSettingsToJSON(json: any): ContentAttemptSettings;
46
+ export declare function ContentAttemptSettingsToJSONTyped(value?: ContentAttemptSettings | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,54 @@
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
+ * @export
16
+ */
17
+ export const ContentAttemptSettingsScoreRollupStrategyEnum = {
18
+ Latest: 'Latest',
19
+ Best: 'Best'
20
+ };
21
+ /**
22
+ * Check if a given object implements the ContentAttemptSettings interface.
23
+ */
24
+ export function instanceOfContentAttemptSettings(value) {
25
+ if (!('maxAttempts' in value) || value['maxAttempts'] === undefined)
26
+ return false;
27
+ if (!('scoreRollupStrategy' in value) || value['scoreRollupStrategy'] === undefined)
28
+ return false;
29
+ return true;
30
+ }
31
+ export function ContentAttemptSettingsFromJSON(json) {
32
+ return ContentAttemptSettingsFromJSONTyped(json, false);
33
+ }
34
+ export function ContentAttemptSettingsFromJSONTyped(json, ignoreDiscriminator) {
35
+ if (json == null) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'maxAttempts': json['max_attempts'],
40
+ 'scoreRollupStrategy': json['score_rollup_strategy'],
41
+ };
42
+ }
43
+ export function ContentAttemptSettingsToJSON(json) {
44
+ return ContentAttemptSettingsToJSONTyped(json, false);
45
+ }
46
+ export function ContentAttemptSettingsToJSONTyped(value, ignoreDiscriminator = false) {
47
+ if (value == null) {
48
+ return value;
49
+ }
50
+ return {
51
+ 'max_attempts': value['maxAttempts'],
52
+ 'score_rollup_strategy': value['scoreRollupStrategy'],
53
+ };
54
+ }
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { GetContentContentData } from './GetContentContentData';
13
+ import type { ContentAttemptSettings } from './ContentAttemptSettings';
13
14
  import type { ContentLaunchMode } from './ContentLaunchMode';
14
15
  /**
15
16
  *
@@ -53,6 +54,12 @@ export interface GetContent {
53
54
  * @memberof GetContent
54
55
  */
55
56
  launchMode: ContentLaunchMode;
57
+ /**
58
+ *
59
+ * @type {ContentAttemptSettings}
60
+ * @memberof GetContent
61
+ */
62
+ attemptSettings: ContentAttemptSettings;
56
63
  /**
57
64
  *
58
65
  * @type {GetContentContentData}
@@ -12,6 +12,7 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  import { GetContentContentDataFromJSON, GetContentContentDataToJSON, } from './GetContentContentData';
15
+ import { ContentAttemptSettingsFromJSON, ContentAttemptSettingsToJSON, } from './ContentAttemptSettings';
15
16
  import { ContentLaunchModeFromJSON, ContentLaunchModeToJSON, } from './ContentLaunchMode';
16
17
  /**
17
18
  * @export
@@ -39,6 +40,8 @@ export function instanceOfGetContent(value) {
39
40
  return false;
40
41
  if (!('launchMode' in value) || value['launchMode'] === undefined)
41
42
  return false;
43
+ if (!('attemptSettings' in value) || value['attemptSettings'] === undefined)
44
+ return false;
42
45
  if (!('contentData' in value) || value['contentData'] === undefined)
43
46
  return false;
44
47
  if (!('published' in value) || value['published'] === undefined)
@@ -59,6 +62,7 @@ export function GetContentFromJSONTyped(json, ignoreDiscriminator) {
59
62
  'description': json['description'] == null ? undefined : json['description'],
60
63
  'contentType': json['content_type'],
61
64
  'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
65
+ 'attemptSettings': ContentAttemptSettingsFromJSON(json['attempt_settings']),
62
66
  'contentData': GetContentContentDataFromJSON(json['content_data']),
63
67
  'order': json['order'] == null ? undefined : json['order'],
64
68
  'published': json['published'],
@@ -82,6 +86,7 @@ export function GetContentToJSONTyped(value, ignoreDiscriminator = false) {
82
86
  'description': value['description'],
83
87
  'content_type': value['contentType'],
84
88
  'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
89
+ 'attempt_settings': ContentAttemptSettingsToJSON(value['attemptSettings']),
85
90
  'content_data': GetContentContentDataToJSON(value['contentData']),
86
91
  'order': value['order'],
87
92
  'published': value['published'],
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { GetCourseStudentReportingEngagement } from './GetCourseStudentReportingEngagement';
13
+ import type { GetCourseStudentReportingModulesInner } from './GetCourseStudentReportingModulesInner';
13
14
  import type { GetCourseStudentReportingCourseInfo } from './GetCourseStudentReportingCourseInfo';
14
15
  import type { GetCourseStudentReportingPerformance } from './GetCourseStudentReportingPerformance';
15
16
  /**
@@ -36,6 +37,12 @@ export interface GetCourseStudentReporting {
36
37
  * @memberof GetCourseStudentReporting
37
38
  */
38
39
  performance: GetCourseStudentReportingPerformance;
40
+ /**
41
+ * Module-level progress for the student within this course.
42
+ * @type {Array<GetCourseStudentReportingModulesInner>}
43
+ * @memberof GetCourseStudentReporting
44
+ */
45
+ modules: Array<GetCourseStudentReportingModulesInner>;
39
46
  }
40
47
  /**
41
48
  * Check if a given object implements the GetCourseStudentReporting interface.
@@ -12,6 +12,7 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  import { GetCourseStudentReportingEngagementFromJSON, GetCourseStudentReportingEngagementToJSON, } from './GetCourseStudentReportingEngagement';
15
+ import { GetCourseStudentReportingModulesInnerFromJSON, GetCourseStudentReportingModulesInnerToJSON, } from './GetCourseStudentReportingModulesInner';
15
16
  import { GetCourseStudentReportingCourseInfoFromJSON, GetCourseStudentReportingCourseInfoToJSON, } from './GetCourseStudentReportingCourseInfo';
16
17
  import { GetCourseStudentReportingPerformanceFromJSON, GetCourseStudentReportingPerformanceToJSON, } from './GetCourseStudentReportingPerformance';
17
18
  /**
@@ -24,6 +25,8 @@ export function instanceOfGetCourseStudentReporting(value) {
24
25
  return false;
25
26
  if (!('performance' in value) || value['performance'] === undefined)
26
27
  return false;
28
+ if (!('modules' in value) || value['modules'] === undefined)
29
+ return false;
27
30
  return true;
28
31
  }
29
32
  export function GetCourseStudentReportingFromJSON(json) {
@@ -37,6 +40,7 @@ export function GetCourseStudentReportingFromJSONTyped(json, ignoreDiscriminator
37
40
  'courseInfo': GetCourseStudentReportingCourseInfoFromJSON(json['course_info']),
38
41
  'engagement': GetCourseStudentReportingEngagementFromJSON(json['engagement']),
39
42
  'performance': GetCourseStudentReportingPerformanceFromJSON(json['performance']),
43
+ 'modules': (json['modules'].map(GetCourseStudentReportingModulesInnerFromJSON)),
40
44
  };
41
45
  }
42
46
  export function GetCourseStudentReportingToJSON(json) {
@@ -50,5 +54,6 @@ export function GetCourseStudentReportingToJSONTyped(value, ignoreDiscriminator
50
54
  'course_info': GetCourseStudentReportingCourseInfoToJSON(value['courseInfo']),
51
55
  'engagement': GetCourseStudentReportingEngagementToJSON(value['engagement']),
52
56
  'performance': GetCourseStudentReportingPerformanceToJSON(value['performance']),
57
+ 'modules': (value['modules'].map(GetCourseStudentReportingModulesInnerToJSON)),
53
58
  };
54
59
  }
@@ -0,0 +1,71 @@
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 GetCourseStudentReportingModulesInner
16
+ */
17
+ export interface GetCourseStudentReportingModulesInner {
18
+ /**
19
+ * The module external ID.
20
+ * @type {string}
21
+ * @memberof GetCourseStudentReportingModulesInner
22
+ */
23
+ moduleId: string;
24
+ /**
25
+ * Module name.
26
+ * @type {string}
27
+ * @memberof GetCourseStudentReportingModulesInner
28
+ */
29
+ name: string;
30
+ /**
31
+ * Order of the module within the course.
32
+ * @type {number}
33
+ * @memberof GetCourseStudentReportingModulesInner
34
+ */
35
+ order: number;
36
+ /**
37
+ * Number of visible content items in the module.
38
+ * @type {number}
39
+ * @memberof GetCourseStudentReportingModulesInner
40
+ */
41
+ contentCount: number;
42
+ /**
43
+ * Number of visible content items completed by the student.
44
+ * @type {number}
45
+ * @memberof GetCourseStudentReportingModulesInner
46
+ */
47
+ contentCompletedCount: number;
48
+ /**
49
+ * Derived module completion status for this student.
50
+ * @type {GetCourseStudentReportingModulesInnerCompletionStatusEnum}
51
+ * @memberof GetCourseStudentReportingModulesInner
52
+ */
53
+ completionStatus: GetCourseStudentReportingModulesInnerCompletionStatusEnum;
54
+ }
55
+ /**
56
+ * @export
57
+ */
58
+ export declare const GetCourseStudentReportingModulesInnerCompletionStatusEnum: {
59
+ readonly NotAttempted: "NotAttempted";
60
+ readonly InProgress: "InProgress";
61
+ readonly Completed: "Completed";
62
+ };
63
+ export type GetCourseStudentReportingModulesInnerCompletionStatusEnum = typeof GetCourseStudentReportingModulesInnerCompletionStatusEnum[keyof typeof GetCourseStudentReportingModulesInnerCompletionStatusEnum];
64
+ /**
65
+ * Check if a given object implements the GetCourseStudentReportingModulesInner interface.
66
+ */
67
+ export declare function instanceOfGetCourseStudentReportingModulesInner(value: object): value is GetCourseStudentReportingModulesInner;
68
+ export declare function GetCourseStudentReportingModulesInnerFromJSON(json: any): GetCourseStudentReportingModulesInner;
69
+ export declare function GetCourseStudentReportingModulesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseStudentReportingModulesInner;
70
+ export declare function GetCourseStudentReportingModulesInnerToJSON(json: any): GetCourseStudentReportingModulesInner;
71
+ export declare function GetCourseStudentReportingModulesInnerToJSONTyped(value?: GetCourseStudentReportingModulesInner | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,71 @@
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
+ * @export
16
+ */
17
+ export const GetCourseStudentReportingModulesInnerCompletionStatusEnum = {
18
+ NotAttempted: 'NotAttempted',
19
+ InProgress: 'InProgress',
20
+ Completed: 'Completed'
21
+ };
22
+ /**
23
+ * Check if a given object implements the GetCourseStudentReportingModulesInner interface.
24
+ */
25
+ export function instanceOfGetCourseStudentReportingModulesInner(value) {
26
+ if (!('moduleId' in value) || value['moduleId'] === undefined)
27
+ return false;
28
+ if (!('name' in value) || value['name'] === undefined)
29
+ return false;
30
+ if (!('order' in value) || value['order'] === undefined)
31
+ return false;
32
+ if (!('contentCount' in value) || value['contentCount'] === undefined)
33
+ return false;
34
+ if (!('contentCompletedCount' in value) || value['contentCompletedCount'] === undefined)
35
+ return false;
36
+ if (!('completionStatus' in value) || value['completionStatus'] === undefined)
37
+ return false;
38
+ return true;
39
+ }
40
+ export function GetCourseStudentReportingModulesInnerFromJSON(json) {
41
+ return GetCourseStudentReportingModulesInnerFromJSONTyped(json, false);
42
+ }
43
+ export function GetCourseStudentReportingModulesInnerFromJSONTyped(json, ignoreDiscriminator) {
44
+ if (json == null) {
45
+ return json;
46
+ }
47
+ return {
48
+ 'moduleId': json['module_id'],
49
+ 'name': json['name'],
50
+ 'order': json['order'],
51
+ 'contentCount': json['content_count'],
52
+ 'contentCompletedCount': json['content_completed_count'],
53
+ 'completionStatus': json['completion_status'],
54
+ };
55
+ }
56
+ export function GetCourseStudentReportingModulesInnerToJSON(json) {
57
+ return GetCourseStudentReportingModulesInnerToJSONTyped(json, false);
58
+ }
59
+ export function GetCourseStudentReportingModulesInnerToJSONTyped(value, ignoreDiscriminator = false) {
60
+ if (value == null) {
61
+ return value;
62
+ }
63
+ return {
64
+ 'module_id': value['moduleId'],
65
+ 'name': value['name'],
66
+ 'order': value['order'],
67
+ 'content_count': value['contentCount'],
68
+ 'content_completed_count': value['contentCompletedCount'],
69
+ 'completion_status': value['completionStatus'],
70
+ };
71
+ }
@@ -11,6 +11,7 @@
11
11
  */
12
12
  import type { GetModuleInstructorBasicReportingModuleInfo } from './GetModuleInstructorBasicReportingModuleInfo';
13
13
  import type { GetModuleStudentReportingAccess } from './GetModuleStudentReportingAccess';
14
+ import type { GetModuleStudentReportingContentsInner } from './GetModuleStudentReportingContentsInner';
14
15
  import type { GetModuleStudentReportingProgress } from './GetModuleStudentReportingProgress';
15
16
  /**
16
17
  *
@@ -36,6 +37,12 @@ export interface GetModuleStudentReporting {
36
37
  * @memberof GetModuleStudentReporting
37
38
  */
38
39
  access: GetModuleStudentReportingAccess;
40
+ /**
41
+ * Content-level progress for the student within this module.
42
+ * @type {Array<GetModuleStudentReportingContentsInner>}
43
+ * @memberof GetModuleStudentReporting
44
+ */
45
+ contents: Array<GetModuleStudentReportingContentsInner>;
39
46
  }
40
47
  /**
41
48
  * Check if a given object implements the GetModuleStudentReporting interface.
@@ -13,6 +13,7 @@
13
13
  */
14
14
  import { GetModuleInstructorBasicReportingModuleInfoFromJSON, GetModuleInstructorBasicReportingModuleInfoToJSON, } from './GetModuleInstructorBasicReportingModuleInfo';
15
15
  import { GetModuleStudentReportingAccessFromJSON, GetModuleStudentReportingAccessToJSON, } from './GetModuleStudentReportingAccess';
16
+ import { GetModuleStudentReportingContentsInnerFromJSON, GetModuleStudentReportingContentsInnerToJSON, } from './GetModuleStudentReportingContentsInner';
16
17
  import { GetModuleStudentReportingProgressFromJSON, GetModuleStudentReportingProgressToJSON, } from './GetModuleStudentReportingProgress';
17
18
  /**
18
19
  * Check if a given object implements the GetModuleStudentReporting interface.
@@ -24,6 +25,8 @@ export function instanceOfGetModuleStudentReporting(value) {
24
25
  return false;
25
26
  if (!('access' in value) || value['access'] === undefined)
26
27
  return false;
28
+ if (!('contents' in value) || value['contents'] === undefined)
29
+ return false;
27
30
  return true;
28
31
  }
29
32
  export function GetModuleStudentReportingFromJSON(json) {
@@ -37,6 +40,7 @@ export function GetModuleStudentReportingFromJSONTyped(json, ignoreDiscriminator
37
40
  'moduleInfo': GetModuleInstructorBasicReportingModuleInfoFromJSON(json['module_info']),
38
41
  'progress': GetModuleStudentReportingProgressFromJSON(json['progress']),
39
42
  'access': GetModuleStudentReportingAccessFromJSON(json['access']),
43
+ 'contents': (json['contents'].map(GetModuleStudentReportingContentsInnerFromJSON)),
40
44
  };
41
45
  }
42
46
  export function GetModuleStudentReportingToJSON(json) {
@@ -50,5 +54,6 @@ export function GetModuleStudentReportingToJSONTyped(value, ignoreDiscriminator
50
54
  'module_info': GetModuleInstructorBasicReportingModuleInfoToJSON(value['moduleInfo']),
51
55
  'progress': GetModuleStudentReportingProgressToJSON(value['progress']),
52
56
  'access': GetModuleStudentReportingAccessToJSON(value['access']),
57
+ 'contents': (value['contents'].map(GetModuleStudentReportingContentsInnerToJSON)),
53
58
  };
54
59
  }
@@ -0,0 +1,101 @@
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 GetModuleStudentReportingContentsInner
16
+ */
17
+ export interface GetModuleStudentReportingContentsInner {
18
+ /**
19
+ * The module external ID.
20
+ * @type {string}
21
+ * @memberof GetModuleStudentReportingContentsInner
22
+ */
23
+ moduleId: string;
24
+ /**
25
+ * The content external ID.
26
+ * @type {string}
27
+ * @memberof GetModuleStudentReportingContentsInner
28
+ */
29
+ contentId: string;
30
+ /**
31
+ * Content name.
32
+ * @type {string}
33
+ * @memberof GetModuleStudentReportingContentsInner
34
+ */
35
+ name: string;
36
+ /**
37
+ * Content type.
38
+ * @type {string}
39
+ * @memberof GetModuleStudentReportingContentsInner
40
+ */
41
+ contentType: string;
42
+ /**
43
+ * Order of the content within the module.
44
+ * @type {number}
45
+ * @memberof GetModuleStudentReportingContentsInner
46
+ */
47
+ order: number;
48
+ /**
49
+ * Current live completion status for this student's content progress.
50
+ * @type {GetModuleStudentReportingContentsInnerCompletionStatusEnum}
51
+ * @memberof GetModuleStudentReportingContentsInner
52
+ */
53
+ completionStatus: GetModuleStudentReportingContentsInnerCompletionStatusEnum;
54
+ /**
55
+ * Current live grade status for this student's content progress, if a session exists.
56
+ * @type {string}
57
+ * @memberof GetModuleStudentReportingContentsInner
58
+ */
59
+ gradeStatus: string | null;
60
+ /**
61
+ * Current live content session external ID, if a session exists.
62
+ * @type {string}
63
+ * @memberof GetModuleStudentReportingContentsInner
64
+ */
65
+ contentSessionId: string | null;
66
+ /**
67
+ * Current live attempt number, if a session exists.
68
+ * @type {number}
69
+ * @memberof GetModuleStudentReportingContentsInner
70
+ */
71
+ attemptNumber: number | null;
72
+ /**
73
+ * Last content session update timestamp (epoch seconds), if a session exists.
74
+ * @type {number}
75
+ * @memberof GetModuleStudentReportingContentsInner
76
+ */
77
+ lastAccessedAt: number | null;
78
+ /**
79
+ * Duration tracked on the current live content session, or 0 when not started.
80
+ * @type {number}
81
+ * @memberof GetModuleStudentReportingContentsInner
82
+ */
83
+ durationInSeconds: number;
84
+ }
85
+ /**
86
+ * @export
87
+ */
88
+ export declare const GetModuleStudentReportingContentsInnerCompletionStatusEnum: {
89
+ readonly NotAttempted: "NotAttempted";
90
+ readonly InProgress: "InProgress";
91
+ readonly Completed: "Completed";
92
+ };
93
+ export type GetModuleStudentReportingContentsInnerCompletionStatusEnum = typeof GetModuleStudentReportingContentsInnerCompletionStatusEnum[keyof typeof GetModuleStudentReportingContentsInnerCompletionStatusEnum];
94
+ /**
95
+ * Check if a given object implements the GetModuleStudentReportingContentsInner interface.
96
+ */
97
+ export declare function instanceOfGetModuleStudentReportingContentsInner(value: object): value is GetModuleStudentReportingContentsInner;
98
+ export declare function GetModuleStudentReportingContentsInnerFromJSON(json: any): GetModuleStudentReportingContentsInner;
99
+ export declare function GetModuleStudentReportingContentsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetModuleStudentReportingContentsInner;
100
+ export declare function GetModuleStudentReportingContentsInnerToJSON(json: any): GetModuleStudentReportingContentsInner;
101
+ export declare function GetModuleStudentReportingContentsInnerToJSONTyped(value?: GetModuleStudentReportingContentsInner | null, ignoreDiscriminator?: boolean): any;