@easyedu/js-lsm-api 1.101.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 (100) hide show
  1. package/.openapi-generator/FILES +14 -0
  2. package/README.md +11 -2
  3. package/dist/apis/CourseApi.d.ts +34 -0
  4. package/dist/apis/CourseApi.js +89 -0
  5. package/dist/esm/apis/CourseApi.d.ts +34 -0
  6. package/dist/esm/apis/CourseApi.js +89 -0
  7. package/dist/esm/models/CourseProgressionMode.d.ts +25 -0
  8. package/dist/esm/models/CourseProgressionMode.js +43 -0
  9. package/dist/esm/models/GetCourseVersion.d.ts +7 -0
  10. package/dist/esm/models/GetCourseVersion.js +5 -0
  11. package/dist/esm/models/GetCourseVersionItem.d.ts +6 -0
  12. package/dist/esm/models/GetCourseVersionItem.js +4 -0
  13. package/dist/esm/models/GetCourseVersionItemProgression.d.ts +105 -0
  14. package/dist/esm/models/GetCourseVersionItemProgression.js +92 -0
  15. package/dist/esm/models/GetCourseVersionItemSession.d.ts +37 -1
  16. package/dist/esm/models/GetCourseVersionItemSession.js +24 -0
  17. package/dist/esm/models/GetCourseVersionProgression.d.ts +59 -0
  18. package/dist/esm/models/GetCourseVersionProgression.js +62 -0
  19. package/dist/esm/models/GetCourseVersionSectionProgression.d.ts +75 -0
  20. package/dist/esm/models/GetCourseVersionSectionProgression.js +72 -0
  21. package/dist/esm/models/GetResourceSession.d.ts +36 -0
  22. package/dist/esm/models/GetResourceSession.js +24 -0
  23. package/dist/esm/models/PostCourseVersionItem.d.ts +6 -0
  24. package/dist/esm/models/PostCourseVersionItem.js +2 -0
  25. package/dist/esm/models/ProgressionGateError.d.ts +76 -0
  26. package/dist/esm/models/ProgressionGateError.js +74 -0
  27. package/dist/esm/models/ProgressionLockReason.d.ts +24 -0
  28. package/dist/esm/models/ProgressionLockReason.js +42 -0
  29. package/dist/esm/models/PutCourseVersionDraft.d.ts +33 -0
  30. package/dist/esm/models/PutCourseVersionDraft.js +44 -0
  31. package/dist/esm/models/PutCourseVersionItem.d.ts +6 -0
  32. package/dist/esm/models/PutCourseVersionItem.js +2 -0
  33. package/dist/esm/models/PutResourceSessionOverride.d.ts +6 -0
  34. package/dist/esm/models/PutResourceSessionOverride.js +2 -0
  35. package/dist/esm/models/index.d.ts +7 -0
  36. package/dist/esm/models/index.js +7 -0
  37. package/dist/models/CourseProgressionMode.d.ts +25 -0
  38. package/dist/models/CourseProgressionMode.js +51 -0
  39. package/dist/models/GetCourseVersion.d.ts +7 -0
  40. package/dist/models/GetCourseVersion.js +5 -0
  41. package/dist/models/GetCourseVersionItem.d.ts +6 -0
  42. package/dist/models/GetCourseVersionItem.js +4 -0
  43. package/dist/models/GetCourseVersionItemProgression.d.ts +105 -0
  44. package/dist/models/GetCourseVersionItemProgression.js +99 -0
  45. package/dist/models/GetCourseVersionItemSession.d.ts +37 -1
  46. package/dist/models/GetCourseVersionItemSession.js +24 -0
  47. package/dist/models/GetCourseVersionProgression.d.ts +59 -0
  48. package/dist/models/GetCourseVersionProgression.js +69 -0
  49. package/dist/models/GetCourseVersionSectionProgression.d.ts +75 -0
  50. package/dist/models/GetCourseVersionSectionProgression.js +79 -0
  51. package/dist/models/GetResourceSession.d.ts +36 -0
  52. package/dist/models/GetResourceSession.js +24 -0
  53. package/dist/models/PostCourseVersionItem.d.ts +6 -0
  54. package/dist/models/PostCourseVersionItem.js +2 -0
  55. package/dist/models/ProgressionGateError.d.ts +76 -0
  56. package/dist/models/ProgressionGateError.js +82 -0
  57. package/dist/models/ProgressionLockReason.d.ts +24 -0
  58. package/dist/models/ProgressionLockReason.js +50 -0
  59. package/dist/models/PutCourseVersionDraft.d.ts +33 -0
  60. package/dist/models/PutCourseVersionDraft.js +51 -0
  61. package/dist/models/PutCourseVersionItem.d.ts +6 -0
  62. package/dist/models/PutCourseVersionItem.js +2 -0
  63. package/dist/models/PutResourceSessionOverride.d.ts +6 -0
  64. package/dist/models/PutResourceSessionOverride.js +2 -0
  65. package/dist/models/index.d.ts +7 -0
  66. package/dist/models/index.js +7 -0
  67. package/docs/CourseApi.md +143 -1
  68. package/docs/CourseProgressionMode.md +33 -0
  69. package/docs/GetCourseVersion.md +2 -0
  70. package/docs/GetCourseVersionItem.md +2 -0
  71. package/docs/GetCourseVersionItemProgression.md +58 -0
  72. package/docs/GetCourseVersionItemSession.md +12 -0
  73. package/docs/GetCourseVersionProgression.md +43 -0
  74. package/docs/GetCourseVersionSectionProgression.md +48 -0
  75. package/docs/GetResourceSession.md +12 -0
  76. package/docs/PlayerApi.md +1 -0
  77. package/docs/PostCourseVersionItem.md +2 -0
  78. package/docs/ProgressionGateError.md +47 -0
  79. package/docs/ProgressionLockReason.md +32 -0
  80. package/docs/PutCourseVersionDraft.md +34 -0
  81. package/docs/PutCourseVersionItem.md +2 -0
  82. package/docs/PutResourceSessionOverride.md +2 -0
  83. package/package.json +1 -1
  84. package/src/apis/CourseApi.ts +133 -0
  85. package/src/apis/PlayerApi.ts +5 -0
  86. package/src/models/CourseProgressionMode.ts +53 -0
  87. package/src/models/GetCourseVersion.ts +16 -0
  88. package/src/models/GetCourseVersionItem.ts +9 -0
  89. package/src/models/GetCourseVersionItemProgression.ts +184 -0
  90. package/src/models/GetCourseVersionItemSession.ts +55 -1
  91. package/src/models/GetCourseVersionProgression.ts +126 -0
  92. package/src/models/GetCourseVersionSectionProgression.ts +139 -0
  93. package/src/models/GetResourceSession.ts +54 -0
  94. package/src/models/PostCourseVersionItem.ts +8 -0
  95. package/src/models/ProgressionGateError.ts +131 -0
  96. package/src/models/ProgressionLockReason.ts +52 -0
  97. package/src/models/PutCourseVersionDraft.ts +76 -0
  98. package/src/models/PutCourseVersionItem.ts +8 -0
  99. package/src/models/PutResourceSessionOverride.ts +8 -0
  100. package/src/models/index.ts +7 -0
@@ -35,6 +35,7 @@ docs/ContentLibraryVersionStatus.md
35
35
  docs/CourseApi.md
36
36
  docs/CourseCatalog.md
37
37
  docs/CourseCatalogApi.md
38
+ docs/CourseProgressionMode.md
38
39
  docs/CourseShare.md
39
40
  docs/CourseShareApi.md
40
41
  docs/DispatchApi.md
@@ -67,12 +68,15 @@ docs/GetCourseList.md
67
68
  docs/GetCourseVersion.md
68
69
  docs/GetCourseVersionItem.md
69
70
  docs/GetCourseVersionItemLaunch.md
71
+ docs/GetCourseVersionItemProgression.md
70
72
  docs/GetCourseVersionItemReporting.md
71
73
  docs/GetCourseVersionItemSession.md
72
74
  docs/GetCourseVersionList.md
75
+ docs/GetCourseVersionProgression.md
73
76
  docs/GetCourseVersionReporting.md
74
77
  docs/GetCourseVersionSection.md
75
78
  docs/GetCourseVersionSectionChild.md
79
+ docs/GetCourseVersionSectionProgression.md
76
80
  docs/GetCourseVersionSectionReporting.md
77
81
  docs/GetEmailAssetUpload.md
78
82
  docs/GetEmailDelivery.md
@@ -226,6 +230,8 @@ docs/PostSignupRequest.md
226
230
  docs/PostSignupRequestResponse.md
227
231
  docs/PostSupportTicket.md
228
232
  docs/PostSupportTicketComment.md
233
+ docs/ProgressionGateError.md
234
+ docs/ProgressionLockReason.md
229
235
  docs/PutAttemptAllowance.md
230
236
  docs/PutBadgeIssuer.md
231
237
  docs/PutCertificateConfig.md
@@ -234,6 +240,7 @@ docs/PutCertificateTemplateDraft.md
234
240
  docs/PutCourse.md
235
241
  docs/PutCourseCatalog.md
236
242
  docs/PutCourseEnrollment.md
243
+ docs/PutCourseVersionDraft.md
237
244
  docs/PutCourseVersionItem.md
238
245
  docs/PutCourseVersionOutlineEntryMove.md
239
246
  docs/PutCourseVersionSection.md
@@ -328,6 +335,7 @@ src/models/CertificateTemplateVersion.ts
328
335
  src/models/ContentLaunchMode.ts
329
336
  src/models/ContentLibraryVersionStatus.ts
330
337
  src/models/CourseCatalog.ts
338
+ src/models/CourseProgressionMode.ts
331
339
  src/models/CourseShare.ts
332
340
  src/models/EffectiveCertificateConfig.ts
333
341
  src/models/EmailTemplateDefinition.ts
@@ -357,12 +365,15 @@ src/models/GetCourseList.ts
357
365
  src/models/GetCourseVersion.ts
358
366
  src/models/GetCourseVersionItem.ts
359
367
  src/models/GetCourseVersionItemLaunch.ts
368
+ src/models/GetCourseVersionItemProgression.ts
360
369
  src/models/GetCourseVersionItemReporting.ts
361
370
  src/models/GetCourseVersionItemSession.ts
362
371
  src/models/GetCourseVersionList.ts
372
+ src/models/GetCourseVersionProgression.ts
363
373
  src/models/GetCourseVersionReporting.ts
364
374
  src/models/GetCourseVersionSection.ts
365
375
  src/models/GetCourseVersionSectionChild.ts
376
+ src/models/GetCourseVersionSectionProgression.ts
366
377
  src/models/GetCourseVersionSectionReporting.ts
367
378
  src/models/GetEmailAssetUpload.ts
368
379
  src/models/GetEmailDelivery.ts
@@ -512,6 +523,8 @@ src/models/PostSignupRequest.ts
512
523
  src/models/PostSignupRequestResponse.ts
513
524
  src/models/PostSupportTicket.ts
514
525
  src/models/PostSupportTicketComment.ts
526
+ src/models/ProgressionGateError.ts
527
+ src/models/ProgressionLockReason.ts
515
528
  src/models/PutAttemptAllowance.ts
516
529
  src/models/PutBadgeIssuer.ts
517
530
  src/models/PutCertificateConfig.ts
@@ -520,6 +533,7 @@ src/models/PutCertificateTemplateDraft.ts
520
533
  src/models/PutCourse.ts
521
534
  src/models/PutCourseCatalog.ts
522
535
  src/models/PutCourseEnrollment.ts
536
+ src/models/PutCourseVersionDraft.ts
523
537
  src/models/PutCourseVersionItem.ts
524
538
  src/models/PutCourseVersionOutlineEntryMove.ts
525
539
  src/models/PutCourseVersionSection.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @easyedu/js-lsm-api@1.101.0
1
+ # @easyedu/js-lsm-api@1.102.0
2
2
 
3
3
  A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
4
4
 
@@ -184,6 +184,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
184
184
  *CourseApi* | [**getCourseVersion**](docs/CourseApi.md#getcourseversion) | **GET** /courses/{courseId}/versions/{courseVersionId} | Get one immutable course version or preview the owned draft
185
185
  *CourseApi* | [**getCourseVersionItemLaunch**](docs/CourseApi.md#getcourseversionitemlaunch) | **GET** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/launch | Resolve the exact immutable resource launch selected by a course version
186
186
  *CourseApi* | [**getCourseVersionList**](docs/CourseApi.md#getcourseversionlist) | **GET** /courses/{courseId}/versions | List immutable course versions and the current draft
187
+ *CourseApi* | [**getCourseVersionProgression**](docs/CourseApi.md#getcourseversionprogression) | **GET** /courses/{courseId}/versions/{courseVersionId}/progression | Get learner-specific completion and section lock state
187
188
  *CourseApi* | [**postCourse**](docs/CourseApi.md#postcourse) | **POST** /courses | Post a new course
188
189
  *CourseApi* | [**postCourseDraft**](docs/CourseApi.md#postcoursedraft) | **POST** /courses/{courseId}/draft | Create or return the single editable course draft
189
190
  *CourseApi* | [**postCourseDraftResourceUpdateAll**](docs/CourseApi.md#postcoursedraftresourceupdateall) | **POST** /courses/{courseId}/draft/resources/update-all | Update all draft resource placements to their latest published versions
@@ -201,6 +202,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
201
202
  *CourseApi* | [**putCourse**](docs/CourseApi.md#putcourse) | **PUT** /courses/{courseId} | Update a course by id
202
203
  *CourseApi* | [**putCourseEnrollment**](docs/CourseApi.md#putcourseenrollment) | **PUT** /courses/{courseId}/enrollments/{enrollmentId} | Update a course enrollment
203
204
  *CourseApi* | [**putCourseItemLearnerAttemptAllowance**](docs/CourseApi.md#putcourseitemlearnerattemptallowance) | **PUT** /courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance | Set extra attempts for a learner on a course item
205
+ *CourseApi* | [**putCourseVersionDraft**](docs/CourseApi.md#putcourseversiondraft) | **PUT** /courses/{courseId}/draft | Update progression settings on the editable course draft
204
206
  *CourseApi* | [**putCourseVersionItem**](docs/CourseApi.md#putcourseversionitem) | **PUT** /courses/{courseId}/draft/sections/{sectionId}/items/{itemId} | Update a draft placement; use the outline move endpoint to change its parent or position
205
207
  *CourseApi* | [**putCourseVersionOutlineEntryMove**](docs/CourseApi.md#putcourseversionoutlineentrymove) | **PUT** /courses/{courseId}/draft/outline/move | Move a section or item to a new parent and sibling position
206
208
  *CourseApi* | [**putCourseVersionSection**](docs/CourseApi.md#putcourseversionsection) | **PUT** /courses/{courseId}/draft/sections/{sectionId} | Update a draft section
@@ -374,6 +376,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
374
376
  - [ContentLaunchMode](docs/ContentLaunchMode.md)
375
377
  - [ContentLibraryVersionStatus](docs/ContentLibraryVersionStatus.md)
376
378
  - [CourseCatalog](docs/CourseCatalog.md)
379
+ - [CourseProgressionMode](docs/CourseProgressionMode.md)
377
380
  - [CourseShare](docs/CourseShare.md)
378
381
  - [EffectiveCertificateConfig](docs/EffectiveCertificateConfig.md)
379
382
  - [EmailTemplateDefinition](docs/EmailTemplateDefinition.md)
@@ -403,12 +406,15 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
403
406
  - [GetCourseVersion](docs/GetCourseVersion.md)
404
407
  - [GetCourseVersionItem](docs/GetCourseVersionItem.md)
405
408
  - [GetCourseVersionItemLaunch](docs/GetCourseVersionItemLaunch.md)
409
+ - [GetCourseVersionItemProgression](docs/GetCourseVersionItemProgression.md)
406
410
  - [GetCourseVersionItemReporting](docs/GetCourseVersionItemReporting.md)
407
411
  - [GetCourseVersionItemSession](docs/GetCourseVersionItemSession.md)
408
412
  - [GetCourseVersionList](docs/GetCourseVersionList.md)
413
+ - [GetCourseVersionProgression](docs/GetCourseVersionProgression.md)
409
414
  - [GetCourseVersionReporting](docs/GetCourseVersionReporting.md)
410
415
  - [GetCourseVersionSection](docs/GetCourseVersionSection.md)
411
416
  - [GetCourseVersionSectionChild](docs/GetCourseVersionSectionChild.md)
417
+ - [GetCourseVersionSectionProgression](docs/GetCourseVersionSectionProgression.md)
412
418
  - [GetCourseVersionSectionReporting](docs/GetCourseVersionSectionReporting.md)
413
419
  - [GetEmailAssetUpload](docs/GetEmailAssetUpload.md)
414
420
  - [GetEmailDelivery](docs/GetEmailDelivery.md)
@@ -558,6 +564,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
558
564
  - [PostSignupRequestResponse](docs/PostSignupRequestResponse.md)
559
565
  - [PostSupportTicket](docs/PostSupportTicket.md)
560
566
  - [PostSupportTicketComment](docs/PostSupportTicketComment.md)
567
+ - [ProgressionGateError](docs/ProgressionGateError.md)
568
+ - [ProgressionLockReason](docs/ProgressionLockReason.md)
561
569
  - [PutAttemptAllowance](docs/PutAttemptAllowance.md)
562
570
  - [PutBadgeIssuer](docs/PutBadgeIssuer.md)
563
571
  - [PutCertificateConfig](docs/PutCertificateConfig.md)
@@ -566,6 +574,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
566
574
  - [PutCourse](docs/PutCourse.md)
567
575
  - [PutCourseCatalog](docs/PutCourseCatalog.md)
568
576
  - [PutCourseEnrollment](docs/PutCourseEnrollment.md)
577
+ - [PutCourseVersionDraft](docs/PutCourseVersionDraft.md)
569
578
  - [PutCourseVersionItem](docs/PutCourseVersionItem.md)
570
579
  - [PutCourseVersionOutlineEntryMove](docs/PutCourseVersionOutlineEntryMove.md)
571
580
  - [PutCourseVersionSection](docs/PutCourseVersionSection.md)
@@ -616,7 +625,7 @@ and is automatically generated by the
616
625
  [OpenAPI Generator](https://openapi-generator.tech) project:
617
626
 
618
627
  - API version: `1.0.0`
619
- - Package version: `1.101.0`
628
+ - Package version: `1.102.0`
620
629
  - Generator version: `7.22.0`
621
630
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
622
631
 
@@ -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
  */
@@ -37,6 +37,7 @@ const GetCourseVersionItem_1 = require("../models/GetCourseVersionItem");
37
37
  const GetCourseVersionItemLaunch_1 = require("../models/GetCourseVersionItemLaunch");
38
38
  const GetCourseVersionItemSession_1 = require("../models/GetCourseVersionItemSession");
39
39
  const GetCourseVersionList_1 = require("../models/GetCourseVersionList");
40
+ const GetCourseVersionProgression_1 = require("../models/GetCourseVersionProgression");
40
41
  const GetCourseVersionSection_1 = require("../models/GetCourseVersionSection");
41
42
  const PostClearSessions_1 = require("../models/PostClearSessions");
42
43
  const PostClearSessionsResponse_1 = require("../models/PostClearSessionsResponse");
@@ -54,6 +55,7 @@ const PostDuplicate_1 = require("../models/PostDuplicate");
54
55
  const PutAttemptAllowance_1 = require("../models/PutAttemptAllowance");
55
56
  const PutCourse_1 = require("../models/PutCourse");
56
57
  const PutCourseEnrollment_1 = require("../models/PutCourseEnrollment");
58
+ const PutCourseVersionDraft_1 = require("../models/PutCourseVersionDraft");
57
59
  const PutCourseVersionItem_1 = require("../models/PutCourseVersionItem");
58
60
  const PutCourseVersionOutlineEntryMove_1 = require("../models/PutCourseVersionOutlineEntryMove");
59
61
  const PutCourseVersionSection_1 = require("../models/PutCourseVersionSection");
@@ -847,6 +849,49 @@ class CourseApi extends runtime.BaseAPI {
847
849
  return yield response.value();
848
850
  });
849
851
  }
852
+ /**
853
+ * Creates request options for getCourseVersionProgression without sending the request
854
+ */
855
+ getCourseVersionProgressionRequestOpts(requestParameters) {
856
+ return __awaiter(this, void 0, void 0, function* () {
857
+ if (requestParameters['courseId'] == null) {
858
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseVersionProgression().');
859
+ }
860
+ if (requestParameters['courseVersionId'] == null) {
861
+ throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionProgression().');
862
+ }
863
+ const queryParameters = {};
864
+ const headerParameters = {};
865
+ let urlPath = `/courses/{courseId}/versions/{courseVersionId}/progression`;
866
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
867
+ urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
868
+ return {
869
+ path: urlPath,
870
+ method: 'GET',
871
+ headers: headerParameters,
872
+ query: queryParameters,
873
+ };
874
+ });
875
+ }
876
+ /**
877
+ * Get learner-specific completion and section lock state
878
+ */
879
+ getCourseVersionProgressionRaw(requestParameters, initOverrides) {
880
+ return __awaiter(this, void 0, void 0, function* () {
881
+ const requestOptions = yield this.getCourseVersionProgressionRequestOpts(requestParameters);
882
+ const response = yield this.request(requestOptions, initOverrides);
883
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetCourseVersionProgression_1.GetCourseVersionProgressionFromJSON)(jsonValue));
884
+ });
885
+ }
886
+ /**
887
+ * Get learner-specific completion and section lock state
888
+ */
889
+ getCourseVersionProgression(requestParameters, initOverrides) {
890
+ return __awaiter(this, void 0, void 0, function* () {
891
+ const response = yield this.getCourseVersionProgressionRaw(requestParameters, initOverrides);
892
+ return yield response.value();
893
+ });
894
+ }
850
895
  /**
851
896
  * Creates request options for postCourse without sending the request
852
897
  */
@@ -1644,6 +1689,50 @@ class CourseApi extends runtime.BaseAPI {
1644
1689
  return yield response.value();
1645
1690
  });
1646
1691
  }
1692
+ /**
1693
+ * Creates request options for putCourseVersionDraft without sending the request
1694
+ */
1695
+ putCourseVersionDraftRequestOpts(requestParameters) {
1696
+ return __awaiter(this, void 0, void 0, function* () {
1697
+ if (requestParameters['courseId'] == null) {
1698
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling putCourseVersionDraft().');
1699
+ }
1700
+ if (requestParameters['putCourseVersionDraft'] == null) {
1701
+ throw new runtime.RequiredError('putCourseVersionDraft', 'Required parameter "putCourseVersionDraft" was null or undefined when calling putCourseVersionDraft().');
1702
+ }
1703
+ const queryParameters = {};
1704
+ const headerParameters = {};
1705
+ headerParameters['Content-Type'] = 'application/json';
1706
+ let urlPath = `/courses/{courseId}/draft`;
1707
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
1708
+ return {
1709
+ path: urlPath,
1710
+ method: 'PUT',
1711
+ headers: headerParameters,
1712
+ query: queryParameters,
1713
+ body: (0, PutCourseVersionDraft_1.PutCourseVersionDraftToJSON)(requestParameters['putCourseVersionDraft']),
1714
+ };
1715
+ });
1716
+ }
1717
+ /**
1718
+ * Update progression settings on the editable course draft
1719
+ */
1720
+ putCourseVersionDraftRaw(requestParameters, initOverrides) {
1721
+ return __awaiter(this, void 0, void 0, function* () {
1722
+ const requestOptions = yield this.putCourseVersionDraftRequestOpts(requestParameters);
1723
+ const response = yield this.request(requestOptions, initOverrides);
1724
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetCourseVersion_1.GetCourseVersionFromJSON)(jsonValue));
1725
+ });
1726
+ }
1727
+ /**
1728
+ * Update progression settings on the editable course draft
1729
+ */
1730
+ putCourseVersionDraft(requestParameters, initOverrides) {
1731
+ return __awaiter(this, void 0, void 0, function* () {
1732
+ const response = yield this.putCourseVersionDraftRaw(requestParameters, initOverrides);
1733
+ return yield response.value();
1734
+ });
1735
+ }
1647
1736
  /**
1648
1737
  * Creates request options for putCourseVersionItem without sending the request
1649
1738
  */
@@ -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
  */
@@ -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
+ }
@@ -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'],