@easyedu/js-lsm-api 1.100.0 → 1.102.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 (123) hide show
  1. package/.openapi-generator/FILES +20 -0
  2. package/README.md +14 -2
  3. package/dist/apis/ChangelogApi.d.ts +32 -0
  4. package/dist/apis/ChangelogApi.js +70 -0
  5. package/dist/apis/CourseApi.d.ts +34 -0
  6. package/dist/apis/CourseApi.js +89 -0
  7. package/dist/apis/index.d.ts +1 -0
  8. package/dist/apis/index.js +1 -0
  9. package/dist/esm/apis/ChangelogApi.d.ts +32 -0
  10. package/dist/esm/apis/ChangelogApi.js +66 -0
  11. package/dist/esm/apis/CourseApi.d.ts +34 -0
  12. package/dist/esm/apis/CourseApi.js +89 -0
  13. package/dist/esm/apis/index.d.ts +1 -0
  14. package/dist/esm/apis/index.js +1 -0
  15. package/dist/esm/models/CourseProgressionMode.d.ts +25 -0
  16. package/dist/esm/models/CourseProgressionMode.js +43 -0
  17. package/dist/esm/models/GetChangelogEntry.d.ts +44 -0
  18. package/dist/esm/models/GetChangelogEntry.js +51 -0
  19. package/dist/esm/models/GetChangelogList.d.ts +33 -0
  20. package/dist/esm/models/GetChangelogList.js +44 -0
  21. package/dist/esm/models/GetCourseVersion.d.ts +7 -0
  22. package/dist/esm/models/GetCourseVersion.js +5 -0
  23. package/dist/esm/models/GetCourseVersionItem.d.ts +6 -0
  24. package/dist/esm/models/GetCourseVersionItem.js +4 -0
  25. package/dist/esm/models/GetCourseVersionItemProgression.d.ts +105 -0
  26. package/dist/esm/models/GetCourseVersionItemProgression.js +92 -0
  27. package/dist/esm/models/GetCourseVersionItemSession.d.ts +37 -1
  28. package/dist/esm/models/GetCourseVersionItemSession.js +24 -0
  29. package/dist/esm/models/GetCourseVersionProgression.d.ts +59 -0
  30. package/dist/esm/models/GetCourseVersionProgression.js +62 -0
  31. package/dist/esm/models/GetCourseVersionSectionProgression.d.ts +75 -0
  32. package/dist/esm/models/GetCourseVersionSectionProgression.js +72 -0
  33. package/dist/esm/models/GetResourceSession.d.ts +36 -0
  34. package/dist/esm/models/GetResourceSession.js +24 -0
  35. package/dist/esm/models/PostCourseVersionItem.d.ts +6 -0
  36. package/dist/esm/models/PostCourseVersionItem.js +2 -0
  37. package/dist/esm/models/ProgressionGateError.d.ts +76 -0
  38. package/dist/esm/models/ProgressionGateError.js +74 -0
  39. package/dist/esm/models/ProgressionLockReason.d.ts +24 -0
  40. package/dist/esm/models/ProgressionLockReason.js +42 -0
  41. package/dist/esm/models/PutCourseVersionDraft.d.ts +33 -0
  42. package/dist/esm/models/PutCourseVersionDraft.js +44 -0
  43. package/dist/esm/models/PutCourseVersionItem.d.ts +6 -0
  44. package/dist/esm/models/PutCourseVersionItem.js +2 -0
  45. package/dist/esm/models/PutResourceSessionOverride.d.ts +6 -0
  46. package/dist/esm/models/PutResourceSessionOverride.js +2 -0
  47. package/dist/esm/models/index.d.ts +9 -0
  48. package/dist/esm/models/index.js +9 -0
  49. package/dist/models/CourseProgressionMode.d.ts +25 -0
  50. package/dist/models/CourseProgressionMode.js +51 -0
  51. package/dist/models/GetChangelogEntry.d.ts +44 -0
  52. package/dist/models/GetChangelogEntry.js +58 -0
  53. package/dist/models/GetChangelogList.d.ts +33 -0
  54. package/dist/models/GetChangelogList.js +51 -0
  55. package/dist/models/GetCourseVersion.d.ts +7 -0
  56. package/dist/models/GetCourseVersion.js +5 -0
  57. package/dist/models/GetCourseVersionItem.d.ts +6 -0
  58. package/dist/models/GetCourseVersionItem.js +4 -0
  59. package/dist/models/GetCourseVersionItemProgression.d.ts +105 -0
  60. package/dist/models/GetCourseVersionItemProgression.js +99 -0
  61. package/dist/models/GetCourseVersionItemSession.d.ts +37 -1
  62. package/dist/models/GetCourseVersionItemSession.js +24 -0
  63. package/dist/models/GetCourseVersionProgression.d.ts +59 -0
  64. package/dist/models/GetCourseVersionProgression.js +69 -0
  65. package/dist/models/GetCourseVersionSectionProgression.d.ts +75 -0
  66. package/dist/models/GetCourseVersionSectionProgression.js +79 -0
  67. package/dist/models/GetResourceSession.d.ts +36 -0
  68. package/dist/models/GetResourceSession.js +24 -0
  69. package/dist/models/PostCourseVersionItem.d.ts +6 -0
  70. package/dist/models/PostCourseVersionItem.js +2 -0
  71. package/dist/models/ProgressionGateError.d.ts +76 -0
  72. package/dist/models/ProgressionGateError.js +82 -0
  73. package/dist/models/ProgressionLockReason.d.ts +24 -0
  74. package/dist/models/ProgressionLockReason.js +50 -0
  75. package/dist/models/PutCourseVersionDraft.d.ts +33 -0
  76. package/dist/models/PutCourseVersionDraft.js +51 -0
  77. package/dist/models/PutCourseVersionItem.d.ts +6 -0
  78. package/dist/models/PutCourseVersionItem.js +2 -0
  79. package/dist/models/PutResourceSessionOverride.d.ts +6 -0
  80. package/dist/models/PutResourceSessionOverride.js +2 -0
  81. package/dist/models/index.d.ts +9 -0
  82. package/dist/models/index.js +9 -0
  83. package/docs/ChangelogApi.md +68 -0
  84. package/docs/CourseApi.md +143 -1
  85. package/docs/CourseProgressionMode.md +33 -0
  86. package/docs/GetChangelogEntry.md +39 -0
  87. package/docs/GetChangelogList.md +34 -0
  88. package/docs/GetCourseVersion.md +2 -0
  89. package/docs/GetCourseVersionItem.md +2 -0
  90. package/docs/GetCourseVersionItemProgression.md +58 -0
  91. package/docs/GetCourseVersionItemSession.md +12 -0
  92. package/docs/GetCourseVersionProgression.md +43 -0
  93. package/docs/GetCourseVersionSectionProgression.md +48 -0
  94. package/docs/GetResourceSession.md +12 -0
  95. package/docs/PlayerApi.md +1 -0
  96. package/docs/PostCourseVersionItem.md +2 -0
  97. package/docs/ProgressionGateError.md +47 -0
  98. package/docs/ProgressionLockReason.md +32 -0
  99. package/docs/PutCourseVersionDraft.md +34 -0
  100. package/docs/PutCourseVersionItem.md +2 -0
  101. package/docs/PutResourceSessionOverride.md +2 -0
  102. package/package.json +1 -1
  103. package/src/apis/ChangelogApi.ts +66 -0
  104. package/src/apis/CourseApi.ts +133 -0
  105. package/src/apis/PlayerApi.ts +5 -0
  106. package/src/apis/index.ts +1 -0
  107. package/src/models/CourseProgressionMode.ts +53 -0
  108. package/src/models/GetChangelogEntry.ts +84 -0
  109. package/src/models/GetChangelogList.ts +74 -0
  110. package/src/models/GetCourseVersion.ts +16 -0
  111. package/src/models/GetCourseVersionItem.ts +9 -0
  112. package/src/models/GetCourseVersionItemProgression.ts +184 -0
  113. package/src/models/GetCourseVersionItemSession.ts +55 -1
  114. package/src/models/GetCourseVersionProgression.ts +126 -0
  115. package/src/models/GetCourseVersionSectionProgression.ts +139 -0
  116. package/src/models/GetResourceSession.ts +54 -0
  117. package/src/models/PostCourseVersionItem.ts +8 -0
  118. package/src/models/ProgressionGateError.ts +131 -0
  119. package/src/models/ProgressionLockReason.ts +52 -0
  120. package/src/models/PutCourseVersionDraft.ts +76 -0
  121. package/src/models/PutCourseVersionItem.ts +8 -0
  122. package/src/models/PutResourceSessionOverride.ts +8 -0
  123. package/src/models/index.ts +9 -0
@@ -23,6 +23,7 @@ import { type GetCourseVersionItem } from '../models/GetCourseVersionItem';
23
23
  import { type GetCourseVersionItemLaunch } from '../models/GetCourseVersionItemLaunch';
24
24
  import { type GetCourseVersionItemSession } from '../models/GetCourseVersionItemSession';
25
25
  import { type GetCourseVersionList } from '../models/GetCourseVersionList';
26
+ import { type GetCourseVersionProgression } from '../models/GetCourseVersionProgression';
26
27
  import { type GetCourseVersionSection } from '../models/GetCourseVersionSection';
27
28
  import { type PostClearSessions } from '../models/PostClearSessions';
28
29
  import { type PostClearSessionsResponse } from '../models/PostClearSessionsResponse';
@@ -40,6 +41,7 @@ import { type PostDuplicate } from '../models/PostDuplicate';
40
41
  import { type PutAttemptAllowance } from '../models/PutAttemptAllowance';
41
42
  import { type PutCourse } from '../models/PutCourse';
42
43
  import { type PutCourseEnrollment } from '../models/PutCourseEnrollment';
44
+ import { type PutCourseVersionDraft } from '../models/PutCourseVersionDraft';
43
45
  import { type PutCourseVersionItem } from '../models/PutCourseVersionItem';
44
46
  import { type PutCourseVersionOutlineEntryMove } from '../models/PutCourseVersionOutlineEntryMove';
45
47
  import { type PutCourseVersionSection } from '../models/PutCourseVersionSection';
@@ -122,6 +124,10 @@ export interface GetCourseVersionItemLaunchRequest {
122
124
  export interface GetCourseVersionListRequest {
123
125
  courseId: string;
124
126
  }
127
+ export interface GetCourseVersionProgressionRequest {
128
+ courseId: string;
129
+ courseVersionId: string;
130
+ }
125
131
  export interface PostCourseRequest {
126
132
  postCourse: PostCourse;
127
133
  }
@@ -199,6 +205,10 @@ export interface PutCourseItemLearnerAttemptAllowanceRequest {
199
205
  userId: string;
200
206
  putAttemptAllowance: PutAttemptAllowance;
201
207
  }
208
+ export interface PutCourseVersionDraftRequest {
209
+ courseId: string;
210
+ putCourseVersionDraft: PutCourseVersionDraft;
211
+ }
202
212
  export interface PutCourseVersionItemRequest {
203
213
  courseId: string;
204
214
  sectionId: string;
@@ -436,6 +446,18 @@ export declare class CourseApi extends runtime.BaseAPI {
436
446
  * List immutable course versions and the current draft
437
447
  */
438
448
  getCourseVersionList(requestParameters: GetCourseVersionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionList>;
449
+ /**
450
+ * Creates request options for getCourseVersionProgression without sending the request
451
+ */
452
+ getCourseVersionProgressionRequestOpts(requestParameters: GetCourseVersionProgressionRequest): Promise<runtime.RequestOpts>;
453
+ /**
454
+ * Get learner-specific completion and section lock state
455
+ */
456
+ getCourseVersionProgressionRaw(requestParameters: GetCourseVersionProgressionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersionProgression>>;
457
+ /**
458
+ * Get learner-specific completion and section lock state
459
+ */
460
+ getCourseVersionProgression(requestParameters: GetCourseVersionProgressionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionProgression>;
439
461
  /**
440
462
  * Creates request options for postCourse without sending the request
441
463
  */
@@ -646,6 +668,18 @@ export declare class CourseApi extends runtime.BaseAPI {
646
668
  * Set extra attempts for a learner on a course item
647
669
  */
648
670
  putCourseItemLearnerAttemptAllowance(requestParameters: PutCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttemptAllowance>;
671
+ /**
672
+ * Creates request options for putCourseVersionDraft without sending the request
673
+ */
674
+ putCourseVersionDraftRequestOpts(requestParameters: PutCourseVersionDraftRequest): Promise<runtime.RequestOpts>;
675
+ /**
676
+ * Update progression settings on the editable course draft
677
+ */
678
+ putCourseVersionDraftRaw(requestParameters: PutCourseVersionDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseVersion>>;
679
+ /**
680
+ * Update progression settings on the editable course draft
681
+ */
682
+ putCourseVersionDraft(requestParameters: PutCourseVersionDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersion>;
649
683
  /**
650
684
  * Creates request options for putCourseVersionItem without sending the request
651
685
  */
@@ -34,6 +34,7 @@ import { GetCourseVersionItemFromJSON, } from '../models/GetCourseVersionItem';
34
34
  import { GetCourseVersionItemLaunchFromJSON, } from '../models/GetCourseVersionItemLaunch';
35
35
  import { GetCourseVersionItemSessionFromJSON, } from '../models/GetCourseVersionItemSession';
36
36
  import { GetCourseVersionListFromJSON, } from '../models/GetCourseVersionList';
37
+ import { GetCourseVersionProgressionFromJSON, } from '../models/GetCourseVersionProgression';
37
38
  import { GetCourseVersionSectionFromJSON, } from '../models/GetCourseVersionSection';
38
39
  import { PostClearSessionsToJSON, } from '../models/PostClearSessions';
39
40
  import { PostClearSessionsResponseFromJSON, } from '../models/PostClearSessionsResponse';
@@ -51,6 +52,7 @@ import { PostDuplicateToJSON, } from '../models/PostDuplicate';
51
52
  import { PutAttemptAllowanceToJSON, } from '../models/PutAttemptAllowance';
52
53
  import { PutCourseToJSON, } from '../models/PutCourse';
53
54
  import { PutCourseEnrollmentToJSON, } from '../models/PutCourseEnrollment';
55
+ import { PutCourseVersionDraftToJSON, } from '../models/PutCourseVersionDraft';
54
56
  import { PutCourseVersionItemToJSON, } from '../models/PutCourseVersionItem';
55
57
  import { PutCourseVersionOutlineEntryMoveToJSON, } from '../models/PutCourseVersionOutlineEntryMove';
56
58
  import { PutCourseVersionSectionToJSON, } from '../models/PutCourseVersionSection';
@@ -844,6 +846,49 @@ export class CourseApi extends runtime.BaseAPI {
844
846
  return yield response.value();
845
847
  });
846
848
  }
849
+ /**
850
+ * Creates request options for getCourseVersionProgression without sending the request
851
+ */
852
+ getCourseVersionProgressionRequestOpts(requestParameters) {
853
+ return __awaiter(this, void 0, void 0, function* () {
854
+ if (requestParameters['courseId'] == null) {
855
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseVersionProgression().');
856
+ }
857
+ if (requestParameters['courseVersionId'] == null) {
858
+ throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionProgression().');
859
+ }
860
+ const queryParameters = {};
861
+ const headerParameters = {};
862
+ let urlPath = `/courses/{courseId}/versions/{courseVersionId}/progression`;
863
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
864
+ urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
865
+ return {
866
+ path: urlPath,
867
+ method: 'GET',
868
+ headers: headerParameters,
869
+ query: queryParameters,
870
+ };
871
+ });
872
+ }
873
+ /**
874
+ * Get learner-specific completion and section lock state
875
+ */
876
+ getCourseVersionProgressionRaw(requestParameters, initOverrides) {
877
+ return __awaiter(this, void 0, void 0, function* () {
878
+ const requestOptions = yield this.getCourseVersionProgressionRequestOpts(requestParameters);
879
+ const response = yield this.request(requestOptions, initOverrides);
880
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseVersionProgressionFromJSON(jsonValue));
881
+ });
882
+ }
883
+ /**
884
+ * Get learner-specific completion and section lock state
885
+ */
886
+ getCourseVersionProgression(requestParameters, initOverrides) {
887
+ return __awaiter(this, void 0, void 0, function* () {
888
+ const response = yield this.getCourseVersionProgressionRaw(requestParameters, initOverrides);
889
+ return yield response.value();
890
+ });
891
+ }
847
892
  /**
848
893
  * Creates request options for postCourse without sending the request
849
894
  */
@@ -1641,6 +1686,50 @@ export class CourseApi extends runtime.BaseAPI {
1641
1686
  return yield response.value();
1642
1687
  });
1643
1688
  }
1689
+ /**
1690
+ * Creates request options for putCourseVersionDraft without sending the request
1691
+ */
1692
+ putCourseVersionDraftRequestOpts(requestParameters) {
1693
+ return __awaiter(this, void 0, void 0, function* () {
1694
+ if (requestParameters['courseId'] == null) {
1695
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling putCourseVersionDraft().');
1696
+ }
1697
+ if (requestParameters['putCourseVersionDraft'] == null) {
1698
+ throw new runtime.RequiredError('putCourseVersionDraft', 'Required parameter "putCourseVersionDraft" was null or undefined when calling putCourseVersionDraft().');
1699
+ }
1700
+ const queryParameters = {};
1701
+ const headerParameters = {};
1702
+ headerParameters['Content-Type'] = 'application/json';
1703
+ let urlPath = `/courses/{courseId}/draft`;
1704
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
1705
+ return {
1706
+ path: urlPath,
1707
+ method: 'PUT',
1708
+ headers: headerParameters,
1709
+ query: queryParameters,
1710
+ body: PutCourseVersionDraftToJSON(requestParameters['putCourseVersionDraft']),
1711
+ };
1712
+ });
1713
+ }
1714
+ /**
1715
+ * Update progression settings on the editable course draft
1716
+ */
1717
+ putCourseVersionDraftRaw(requestParameters, initOverrides) {
1718
+ return __awaiter(this, void 0, void 0, function* () {
1719
+ const requestOptions = yield this.putCourseVersionDraftRequestOpts(requestParameters);
1720
+ const response = yield this.request(requestOptions, initOverrides);
1721
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseVersionFromJSON(jsonValue));
1722
+ });
1723
+ }
1724
+ /**
1725
+ * Update progression settings on the editable course draft
1726
+ */
1727
+ putCourseVersionDraft(requestParameters, initOverrides) {
1728
+ return __awaiter(this, void 0, void 0, function* () {
1729
+ const response = yield this.putCourseVersionDraftRaw(requestParameters, initOverrides);
1730
+ return yield response.value();
1731
+ });
1732
+ }
1644
1733
  /**
1645
1734
  * Creates request options for putCourseVersionItem without sending the request
1646
1735
  */
@@ -1,5 +1,6 @@
1
1
  export * from './CertificateApi';
2
2
  export * from './CertificateTemplateApi';
3
+ export * from './ChangelogApi';
3
4
  export * from './ChatApi';
4
5
  export * from './ContentLibraryApi';
5
6
  export * from './ContentLibraryQuizApi';
@@ -2,6 +2,7 @@
2
2
  /* eslint-disable */
3
3
  export * from './CertificateApi';
4
4
  export * from './CertificateTemplateApi';
5
+ export * from './ChangelogApi';
5
6
  export * from './ChatApi';
6
7
  export * from './ContentLibraryApi';
7
8
  export * from './ContentLibraryQuizApi';
@@ -0,0 +1,25 @@
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
+ * Controls whether top-level course sections unlock freely or in completion order.
14
+ * @export
15
+ */
16
+ export declare const CourseProgressionMode: {
17
+ readonly Free: "free";
18
+ readonly SequentialSections: "sequential_sections";
19
+ };
20
+ export type CourseProgressionMode = typeof CourseProgressionMode[keyof typeof CourseProgressionMode];
21
+ export declare function instanceOfCourseProgressionMode(value: any): boolean;
22
+ export declare function CourseProgressionModeFromJSON(json: any): CourseProgressionMode;
23
+ export declare function CourseProgressionModeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CourseProgressionMode;
24
+ export declare function CourseProgressionModeToJSON(value?: CourseProgressionMode | null): any;
25
+ export declare function CourseProgressionModeToJSONTyped(value: any, ignoreDiscriminator: boolean): CourseProgressionMode;
@@ -0,0 +1,43 @@
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
+ * Controls whether top-level course sections unlock freely or in completion order.
16
+ * @export
17
+ */
18
+ export const CourseProgressionMode = {
19
+ Free: 'free',
20
+ SequentialSections: 'sequential_sections'
21
+ };
22
+ export function instanceOfCourseProgressionMode(value) {
23
+ for (const key in CourseProgressionMode) {
24
+ if (Object.prototype.hasOwnProperty.call(CourseProgressionMode, key)) {
25
+ if (CourseProgressionMode[key] === value) {
26
+ return true;
27
+ }
28
+ }
29
+ }
30
+ return false;
31
+ }
32
+ export function CourseProgressionModeFromJSON(json) {
33
+ return CourseProgressionModeFromJSONTyped(json, false);
34
+ }
35
+ export function CourseProgressionModeFromJSONTyped(json, ignoreDiscriminator) {
36
+ return json;
37
+ }
38
+ export function CourseProgressionModeToJSON(value) {
39
+ return value;
40
+ }
41
+ export function CourseProgressionModeToJSONTyped(value, ignoreDiscriminator) {
42
+ return value;
43
+ }
@@ -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
+ * A user-facing summary of product changes published on one date.
14
+ * @export
15
+ * @interface GetChangelogEntry
16
+ */
17
+ export interface GetChangelogEntry {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof GetChangelogEntry
22
+ */
23
+ title: string;
24
+ /**
25
+ * A short Markdown-formatted summary. Multiple changes are represented as bullet points.
26
+ * @type {string}
27
+ * @memberof GetChangelogEntry
28
+ */
29
+ desc: string;
30
+ /**
31
+ *
32
+ * @type {Date}
33
+ * @memberof GetChangelogEntry
34
+ */
35
+ date: Date;
36
+ }
37
+ /**
38
+ * Check if a given object implements the GetChangelogEntry interface.
39
+ */
40
+ export declare function instanceOfGetChangelogEntry(value: object): value is GetChangelogEntry;
41
+ export declare function GetChangelogEntryFromJSON(json: any): GetChangelogEntry;
42
+ export declare function GetChangelogEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChangelogEntry;
43
+ export declare function GetChangelogEntryToJSON(json: any): GetChangelogEntry;
44
+ export declare function GetChangelogEntryToJSONTyped(value?: GetChangelogEntry | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
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 GetChangelogEntry interface.
16
+ */
17
+ export function instanceOfGetChangelogEntry(value) {
18
+ if (!('title' in value) || value['title'] === undefined)
19
+ return false;
20
+ if (!('desc' in value) || value['desc'] === undefined)
21
+ return false;
22
+ if (!('date' in value) || value['date'] === undefined)
23
+ return false;
24
+ return true;
25
+ }
26
+ export function GetChangelogEntryFromJSON(json) {
27
+ return GetChangelogEntryFromJSONTyped(json, false);
28
+ }
29
+ export function GetChangelogEntryFromJSONTyped(json, ignoreDiscriminator) {
30
+ if (json == null) {
31
+ return json;
32
+ }
33
+ return {
34
+ 'title': json['title'],
35
+ 'desc': json['desc'],
36
+ 'date': (new Date(json['date'])),
37
+ };
38
+ }
39
+ export function GetChangelogEntryToJSON(json) {
40
+ return GetChangelogEntryToJSONTyped(json, false);
41
+ }
42
+ export function GetChangelogEntryToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'title': value['title'],
48
+ 'desc': value['desc'],
49
+ 'date': value['date'].toISOString().substring(0, 10),
50
+ };
51
+ }
@@ -0,0 +1,33 @@
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 { GetChangelogEntry } from './GetChangelogEntry';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface GetChangelogList
17
+ */
18
+ export interface GetChangelogList {
19
+ /**
20
+ *
21
+ * @type {Array<GetChangelogEntry>}
22
+ * @memberof GetChangelogList
23
+ */
24
+ items: Array<GetChangelogEntry>;
25
+ }
26
+ /**
27
+ * Check if a given object implements the GetChangelogList interface.
28
+ */
29
+ export declare function instanceOfGetChangelogList(value: object): value is GetChangelogList;
30
+ export declare function GetChangelogListFromJSON(json: any): GetChangelogList;
31
+ export declare function GetChangelogListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChangelogList;
32
+ export declare function GetChangelogListToJSON(json: any): GetChangelogList;
33
+ export declare function GetChangelogListToJSONTyped(value?: GetChangelogList | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,44 @@
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 { GetChangelogEntryFromJSON, GetChangelogEntryToJSON, } from './GetChangelogEntry';
15
+ /**
16
+ * Check if a given object implements the GetChangelogList interface.
17
+ */
18
+ export function instanceOfGetChangelogList(value) {
19
+ if (!('items' in value) || value['items'] === undefined)
20
+ return false;
21
+ return true;
22
+ }
23
+ export function GetChangelogListFromJSON(json) {
24
+ return GetChangelogListFromJSONTyped(json, false);
25
+ }
26
+ export function GetChangelogListFromJSONTyped(json, ignoreDiscriminator) {
27
+ if (json == null) {
28
+ return json;
29
+ }
30
+ return {
31
+ 'items': (json['items'].map(GetChangelogEntryFromJSON)),
32
+ };
33
+ }
34
+ export function GetChangelogListToJSON(json) {
35
+ return GetChangelogListToJSONTyped(json, false);
36
+ }
37
+ export function GetChangelogListToJSONTyped(value, ignoreDiscriminator = false) {
38
+ if (value == null) {
39
+ return value;
40
+ }
41
+ return {
42
+ 'items': (value['items'].map(GetChangelogEntryToJSON)),
43
+ };
44
+ }
@@ -11,6 +11,7 @@
11
11
  */
12
12
  import type { ContentLibraryVersionStatus } from './ContentLibraryVersionStatus';
13
13
  import type { RichTextDocument } from './RichTextDocument';
14
+ import type { CourseProgressionMode } from './CourseProgressionMode';
14
15
  import type { GetCourseVersionSection } from './GetCourseVersionSection';
15
16
  /**
16
17
  *
@@ -66,6 +67,12 @@ export interface GetCourseVersion {
66
67
  * @memberof GetCourseVersion
67
68
  */
68
69
  changeNotes?: string | null;
70
+ /**
71
+ *
72
+ * @type {CourseProgressionMode}
73
+ * @memberof GetCourseVersion
74
+ */
75
+ progressionMode: CourseProgressionMode;
69
76
  /**
70
77
  *
71
78
  * @type {Array<GetCourseVersionSection>}
@@ -13,6 +13,7 @@
13
13
  */
14
14
  import { ContentLibraryVersionStatusFromJSON, ContentLibraryVersionStatusToJSON, } from './ContentLibraryVersionStatus';
15
15
  import { RichTextDocumentFromJSON, RichTextDocumentToJSON, } from './RichTextDocument';
16
+ import { CourseProgressionModeFromJSON, CourseProgressionModeToJSON, } from './CourseProgressionMode';
16
17
  import { GetCourseVersionSectionFromJSON, GetCourseVersionSectionToJSON, } from './GetCourseVersionSection';
17
18
  /**
18
19
  * Check if a given object implements the GetCourseVersion interface.
@@ -32,6 +33,8 @@ export function instanceOfGetCourseVersion(value) {
32
33
  return false;
33
34
  if (!('descriptionRich' in value) || value['descriptionRich'] === undefined)
34
35
  return false;
36
+ if (!('progressionMode' in value) || value['progressionMode'] === undefined)
37
+ return false;
35
38
  if (!('sections' in value) || value['sections'] === undefined)
36
39
  return false;
37
40
  if (!('createdAt' in value) || value['createdAt'] === undefined)
@@ -56,6 +59,7 @@ export function GetCourseVersionFromJSONTyped(json, ignoreDiscriminator) {
56
59
  'description': json['description'],
57
60
  'descriptionRich': RichTextDocumentFromJSON(json['description_rich']),
58
61
  'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
62
+ 'progressionMode': CourseProgressionModeFromJSON(json['progression_mode']),
59
63
  'sections': (json['sections'].map(GetCourseVersionSectionFromJSON)),
60
64
  'createdAt': json['created_at'],
61
65
  'updatedAt': json['updated_at'],
@@ -78,6 +82,7 @@ export function GetCourseVersionToJSONTyped(value, ignoreDiscriminator = false)
78
82
  'description': value['description'],
79
83
  'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
80
84
  'change_notes': value['changeNotes'],
85
+ 'progression_mode': CourseProgressionModeToJSON(value['progressionMode']),
81
86
  'sections': (value['sections'].map(GetCourseVersionSectionToJSON)),
82
87
  'created_at': value['createdAt'],
83
88
  'updated_at': value['updatedAt'],
@@ -88,6 +88,12 @@ export interface GetCourseVersionItem {
88
88
  * @memberof GetCourseVersionItem
89
89
  */
90
90
  isRequired: boolean;
91
+ /**
92
+ * Minimum cumulative active time required for this resource placement. Null disables the timer.
93
+ * @type {number}
94
+ * @memberof GetCourseVersionItem
95
+ */
96
+ minimumActiveSeconds: number | null;
91
97
  /**
92
98
  *
93
99
  * @type {ContentLaunchMode}
@@ -50,6 +50,8 @@ export function instanceOfGetCourseVersionItem(value) {
50
50
  return false;
51
51
  if (!('isRequired' in value) || value['isRequired'] === undefined)
52
52
  return false;
53
+ if (!('minimumActiveSeconds' in value) || value['minimumActiveSeconds'] === undefined)
54
+ return false;
53
55
  if (!('launchMode' in value) || value['launchMode'] === undefined)
54
56
  return false;
55
57
  if (!('maxAttempts' in value) || value['maxAttempts'] === undefined)
@@ -80,6 +82,7 @@ export function GetCourseVersionItemFromJSONTyped(json, ignoreDiscriminator) {
80
82
  'displayOrder': json['display_order'],
81
83
  'isVisible': json['is_visible'],
82
84
  'isRequired': json['is_required'],
85
+ 'minimumActiveSeconds': json['minimum_active_seconds'],
83
86
  'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
84
87
  'maxAttempts': json['max_attempts'],
85
88
  'scoreRollupStrategy': json['score_rollup_strategy'],
@@ -106,6 +109,7 @@ export function GetCourseVersionItemToJSONTyped(value, ignoreDiscriminator = fal
106
109
  'display_order': value['displayOrder'],
107
110
  'is_visible': value['isVisible'],
108
111
  'is_required': value['isRequired'],
112
+ 'minimum_active_seconds': value['minimumActiveSeconds'],
109
113
  'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
110
114
  'max_attempts': value['maxAttempts'],
111
115
  'score_rollup_strategy': value['scoreRollupStrategy'],
@@ -0,0 +1,105 @@
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 { ProgressionLockReason } from './ProgressionLockReason';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface GetCourseVersionItemProgression
17
+ */
18
+ export interface GetCourseVersionItemProgression {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof GetCourseVersionItemProgression
23
+ */
24
+ itemId: string;
25
+ /**
26
+ *
27
+ * @type {string}
28
+ * @memberof GetCourseVersionItemProgression
29
+ */
30
+ rootSectionId: string;
31
+ /**
32
+ *
33
+ * @type {boolean}
34
+ * @memberof GetCourseVersionItemProgression
35
+ */
36
+ isRequired: boolean;
37
+ /**
38
+ *
39
+ * @type {boolean}
40
+ * @memberof GetCourseVersionItemProgression
41
+ */
42
+ isLocked: boolean;
43
+ /**
44
+ *
45
+ * @type {ProgressionLockReason}
46
+ * @memberof GetCourseVersionItemProgression
47
+ */
48
+ lockReason: ProgressionLockReason | null;
49
+ /**
50
+ *
51
+ * @type {string}
52
+ * @memberof GetCourseVersionItemProgression
53
+ */
54
+ blockingSectionId: string | null;
55
+ /**
56
+ *
57
+ * @type {boolean}
58
+ * @memberof GetCourseVersionItemProgression
59
+ */
60
+ nativeCompleted: boolean;
61
+ /**
62
+ *
63
+ * @type {boolean}
64
+ * @memberof GetCourseVersionItemProgression
65
+ */
66
+ effectiveCompleted: boolean;
67
+ /**
68
+ *
69
+ * @type {number}
70
+ * @memberof GetCourseVersionItemProgression
71
+ */
72
+ activeSeconds: number;
73
+ /**
74
+ *
75
+ * @type {number}
76
+ * @memberof GetCourseVersionItemProgression
77
+ */
78
+ minimumActiveSeconds: number | null;
79
+ /**
80
+ *
81
+ * @type {number}
82
+ * @memberof GetCourseVersionItemProgression
83
+ */
84
+ remainingActiveSeconds: number;
85
+ /**
86
+ *
87
+ * @type {boolean}
88
+ * @memberof GetCourseVersionItemProgression
89
+ */
90
+ timeRequirementMet: boolean;
91
+ /**
92
+ *
93
+ * @type {boolean}
94
+ * @memberof GetCourseVersionItemProgression
95
+ */
96
+ timeRequirementWaived: boolean;
97
+ }
98
+ /**
99
+ * Check if a given object implements the GetCourseVersionItemProgression interface.
100
+ */
101
+ export declare function instanceOfGetCourseVersionItemProgression(value: object): value is GetCourseVersionItemProgression;
102
+ export declare function GetCourseVersionItemProgressionFromJSON(json: any): GetCourseVersionItemProgression;
103
+ export declare function GetCourseVersionItemProgressionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionItemProgression;
104
+ export declare function GetCourseVersionItemProgressionToJSON(json: any): GetCourseVersionItemProgression;
105
+ export declare function GetCourseVersionItemProgressionToJSONTyped(value?: GetCourseVersionItemProgression | null, ignoreDiscriminator?: boolean): any;