@easyedu/js-lsm-api 1.98.0 → 1.100.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 (110) hide show
  1. package/.openapi-generator/FILES +22 -0
  2. package/README.md +21 -2
  3. package/dist/apis/ContentLibraryQuizApi.d.ts +17 -0
  4. package/dist/apis/ContentLibraryQuizApi.js +45 -0
  5. package/dist/apis/CourseApi.d.ts +60 -0
  6. package/dist/apis/CourseApi.js +167 -0
  7. package/dist/apis/PlayerApi.d.ts +74 -0
  8. package/dist/apis/PlayerApi.js +193 -0
  9. package/dist/esm/apis/ContentLibraryQuizApi.d.ts +17 -0
  10. package/dist/esm/apis/ContentLibraryQuizApi.js +45 -0
  11. package/dist/esm/apis/CourseApi.d.ts +60 -0
  12. package/dist/esm/apis/CourseApi.js +167 -0
  13. package/dist/esm/apis/PlayerApi.d.ts +74 -0
  14. package/dist/esm/apis/PlayerApi.js +193 -0
  15. package/dist/esm/models/GetAttemptAllowance.d.ts +80 -0
  16. package/dist/esm/models/GetAttemptAllowance.js +75 -0
  17. package/dist/esm/models/GetCourseVersionItemSession.d.ts +6 -0
  18. package/dist/esm/models/GetCourseVersionItemSession.js +4 -0
  19. package/dist/esm/models/GetLibraryQuizSession.d.ts +6 -0
  20. package/dist/esm/models/GetLibraryQuizSession.js +4 -0
  21. package/dist/esm/models/GetResourceSession.d.ts +6 -0
  22. package/dist/esm/models/GetResourceSession.js +4 -0
  23. package/dist/esm/models/GetResourceSessionActivity.d.ts +125 -0
  24. package/dist/esm/models/GetResourceSessionActivity.js +97 -0
  25. package/dist/esm/models/GetResourceSessionActivityEvent.d.ts +62 -0
  26. package/dist/esm/models/GetResourceSessionActivityEvent.js +61 -0
  27. package/dist/esm/models/GetResourceSessionActivityEventList.d.ts +33 -0
  28. package/dist/esm/models/GetResourceSessionActivityEventList.js +44 -0
  29. package/dist/esm/models/GetResourceSessionActivityList.d.ts +33 -0
  30. package/dist/esm/models/GetResourceSessionActivityList.js +44 -0
  31. package/dist/esm/models/PostClearSessions.d.ts +32 -0
  32. package/dist/esm/models/PostClearSessions.js +43 -0
  33. package/dist/esm/models/PostClearSessionsResponse.d.ts +44 -0
  34. package/dist/esm/models/PostClearSessionsResponse.js +51 -0
  35. package/dist/esm/models/PostResourceSessionActivityEvent.d.ts +62 -0
  36. package/dist/esm/models/PostResourceSessionActivityEvent.js +66 -0
  37. package/dist/esm/models/PutAttemptAllowance.d.ts +38 -0
  38. package/dist/esm/models/PutAttemptAllowance.js +47 -0
  39. package/dist/esm/models/PutLibraryQuizSessionOverride.d.ts +57 -0
  40. package/dist/esm/models/PutLibraryQuizSessionOverride.js +55 -0
  41. package/dist/esm/models/PutResourceSessionOverride.d.ts +69 -0
  42. package/dist/esm/models/PutResourceSessionOverride.js +66 -0
  43. package/dist/esm/models/index.d.ts +11 -0
  44. package/dist/esm/models/index.js +11 -0
  45. package/dist/models/GetAttemptAllowance.d.ts +80 -0
  46. package/dist/models/GetAttemptAllowance.js +82 -0
  47. package/dist/models/GetCourseVersionItemSession.d.ts +6 -0
  48. package/dist/models/GetCourseVersionItemSession.js +4 -0
  49. package/dist/models/GetLibraryQuizSession.d.ts +6 -0
  50. package/dist/models/GetLibraryQuizSession.js +4 -0
  51. package/dist/models/GetResourceSession.d.ts +6 -0
  52. package/dist/models/GetResourceSession.js +4 -0
  53. package/dist/models/GetResourceSessionActivity.d.ts +125 -0
  54. package/dist/models/GetResourceSessionActivity.js +105 -0
  55. package/dist/models/GetResourceSessionActivityEvent.d.ts +62 -0
  56. package/dist/models/GetResourceSessionActivityEvent.js +68 -0
  57. package/dist/models/GetResourceSessionActivityEventList.d.ts +33 -0
  58. package/dist/models/GetResourceSessionActivityEventList.js +51 -0
  59. package/dist/models/GetResourceSessionActivityList.d.ts +33 -0
  60. package/dist/models/GetResourceSessionActivityList.js +51 -0
  61. package/dist/models/PostClearSessions.d.ts +32 -0
  62. package/dist/models/PostClearSessions.js +50 -0
  63. package/dist/models/PostClearSessionsResponse.d.ts +44 -0
  64. package/dist/models/PostClearSessionsResponse.js +58 -0
  65. package/dist/models/PostResourceSessionActivityEvent.d.ts +62 -0
  66. package/dist/models/PostResourceSessionActivityEvent.js +74 -0
  67. package/dist/models/PutAttemptAllowance.d.ts +38 -0
  68. package/dist/models/PutAttemptAllowance.js +54 -0
  69. package/dist/models/PutLibraryQuizSessionOverride.d.ts +57 -0
  70. package/dist/models/PutLibraryQuizSessionOverride.js +63 -0
  71. package/dist/models/PutResourceSessionOverride.d.ts +69 -0
  72. package/dist/models/PutResourceSessionOverride.js +74 -0
  73. package/dist/models/index.d.ts +11 -0
  74. package/dist/models/index.js +11 -0
  75. package/docs/ContentLibraryQuizApi.md +73 -2
  76. package/docs/CourseApi.md +236 -0
  77. package/docs/GetAttemptAllowance.md +51 -0
  78. package/docs/GetCourseVersionItemSession.md +2 -0
  79. package/docs/GetLibraryQuizSession.md +2 -0
  80. package/docs/GetResourceSession.md +2 -0
  81. package/docs/GetResourceSessionActivity.md +63 -0
  82. package/docs/GetResourceSessionActivityEvent.md +45 -0
  83. package/docs/GetResourceSessionActivityEventList.md +35 -0
  84. package/docs/GetResourceSessionActivityList.md +35 -0
  85. package/docs/PlayerApi.md +302 -6
  86. package/docs/PostClearSessions.md +34 -0
  87. package/docs/PostClearSessionsResponse.md +38 -0
  88. package/docs/PostResourceSessionActivityEvent.md +39 -0
  89. package/docs/PutAttemptAllowance.md +36 -0
  90. package/docs/PutLibraryQuizSessionOverride.md +41 -0
  91. package/docs/PutResourceSessionOverride.md +41 -0
  92. package/package.json +1 -1
  93. package/src/apis/ContentLibraryQuizApi.ts +65 -0
  94. package/src/apis/CourseApi.ts +270 -0
  95. package/src/apis/PlayerApi.ts +282 -0
  96. package/src/models/GetAttemptAllowance.ts +138 -0
  97. package/src/models/GetCourseVersionItemSession.ts +9 -0
  98. package/src/models/GetLibraryQuizSession.ts +9 -0
  99. package/src/models/GetResourceSession.ts +9 -0
  100. package/src/models/GetResourceSessionActivity.ts +199 -0
  101. package/src/models/GetResourceSessionActivityEvent.ts +110 -0
  102. package/src/models/GetResourceSessionActivityEventList.ts +74 -0
  103. package/src/models/GetResourceSessionActivityList.ts +74 -0
  104. package/src/models/PostClearSessions.ts +66 -0
  105. package/src/models/PostClearSessionsResponse.ts +84 -0
  106. package/src/models/PostResourceSessionActivityEvent.ts +104 -0
  107. package/src/models/PutAttemptAllowance.ts +75 -0
  108. package/src/models/PutLibraryQuizSessionOverride.ts +100 -0
  109. package/src/models/PutResourceSessionOverride.ts +113 -0
  110. package/src/models/index.ts +11 -0
@@ -41,6 +41,7 @@ import { PutLibraryQuizCriteriaToJSON, } from '../models/PutLibraryQuizCriteria'
41
41
  import { PutLibraryQuizQuestionsToJSON, } from '../models/PutLibraryQuizQuestions';
42
42
  import { PutLibraryQuizSessionAnswerToJSON, } from '../models/PutLibraryQuizSessionAnswer';
43
43
  import { PutLibraryQuizSessionGradeToJSON, } from '../models/PutLibraryQuizSessionGrade';
44
+ import { PutLibraryQuizSessionOverrideToJSON, } from '../models/PutLibraryQuizSessionOverride';
44
45
  import { PutLibraryQuizVersionToJSON, } from '../models/PutLibraryQuizVersion';
45
46
  /**
46
47
  *
@@ -1156,6 +1157,50 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
1156
1157
  return yield response.value();
1157
1158
  });
1158
1159
  }
1160
+ /**
1161
+ * Creates request options for putLibraryQuizSessionOverride without sending the request
1162
+ */
1163
+ putLibraryQuizSessionOverrideRequestOpts(requestParameters) {
1164
+ return __awaiter(this, void 0, void 0, function* () {
1165
+ if (requestParameters['sessionId'] == null) {
1166
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling putLibraryQuizSessionOverride().');
1167
+ }
1168
+ if (requestParameters['putLibraryQuizSessionOverride'] == null) {
1169
+ throw new runtime.RequiredError('putLibraryQuizSessionOverride', 'Required parameter "putLibraryQuizSessionOverride" was null or undefined when calling putLibraryQuizSessionOverride().');
1170
+ }
1171
+ const queryParameters = {};
1172
+ const headerParameters = {};
1173
+ headerParameters['Content-Type'] = 'application/json';
1174
+ let urlPath = `/quiz/sessions/{sessionId}/override`;
1175
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
1176
+ return {
1177
+ path: urlPath,
1178
+ method: 'PUT',
1179
+ headers: headerParameters,
1180
+ query: queryParameters,
1181
+ body: PutLibraryQuizSessionOverrideToJSON(requestParameters['putLibraryQuizSessionOverride']),
1182
+ };
1183
+ });
1184
+ }
1185
+ /**
1186
+ * Override a learner\'s live quiz-session progress
1187
+ */
1188
+ putLibraryQuizSessionOverrideRaw(requestParameters, initOverrides) {
1189
+ return __awaiter(this, void 0, void 0, function* () {
1190
+ const requestOptions = yield this.putLibraryQuizSessionOverrideRequestOpts(requestParameters);
1191
+ const response = yield this.request(requestOptions, initOverrides);
1192
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetLibraryQuizSessionFromJSON(jsonValue));
1193
+ });
1194
+ }
1195
+ /**
1196
+ * Override a learner\'s live quiz-session progress
1197
+ */
1198
+ putLibraryQuizSessionOverride(requestParameters, initOverrides) {
1199
+ return __awaiter(this, void 0, void 0, function* () {
1200
+ const response = yield this.putLibraryQuizSessionOverrideRaw(requestParameters, initOverrides);
1201
+ return yield response.value();
1202
+ });
1203
+ }
1159
1204
  /**
1160
1205
  * Creates request options for putLibraryQuizVersion without sending the request
1161
1206
  */
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
+ import { type GetAttemptAllowance } from '../models/GetAttemptAllowance';
13
14
  import { type GetCourse } from '../models/GetCourse';
14
15
  import { type GetCourseEnrollment } from '../models/GetCourseEnrollment';
15
16
  import { type GetCourseEnrollmentList } from '../models/GetCourseEnrollmentList';
@@ -23,6 +24,8 @@ import { type GetCourseVersionItemLaunch } from '../models/GetCourseVersionItemL
23
24
  import { type GetCourseVersionItemSession } from '../models/GetCourseVersionItemSession';
24
25
  import { type GetCourseVersionList } from '../models/GetCourseVersionList';
25
26
  import { type GetCourseVersionSection } from '../models/GetCourseVersionSection';
27
+ import { type PostClearSessions } from '../models/PostClearSessions';
28
+ import { type PostClearSessionsResponse } from '../models/PostClearSessionsResponse';
26
29
  import { type PostCourse } from '../models/PostCourse';
27
30
  import { type PostCourseDraft } from '../models/PostCourseDraft';
28
31
  import { type PostCourseEnrollment } from '../models/PostCourseEnrollment';
@@ -34,6 +37,7 @@ import { type PostCourseVersionPublish } from '../models/PostCourseVersionPublis
34
37
  import { type PostCourseVersionSection } from '../models/PostCourseVersionSection';
35
38
  import { type PostCourseVersionSectionDuplicate } from '../models/PostCourseVersionSectionDuplicate';
36
39
  import { type PostDuplicate } from '../models/PostDuplicate';
40
+ import { type PutAttemptAllowance } from '../models/PutAttemptAllowance';
37
41
  import { type PutCourse } from '../models/PutCourse';
38
42
  import { type PutCourseEnrollment } from '../models/PutCourseEnrollment';
39
43
  import { type PutCourseVersionItem } from '../models/PutCourseVersionItem';
@@ -93,6 +97,12 @@ export interface GetCourseExportsRequest {
93
97
  page?: number;
94
98
  pageSize?: number;
95
99
  }
100
+ export interface GetCourseItemLearnerAttemptAllowanceRequest {
101
+ courseId: string;
102
+ courseVersionId: string;
103
+ itemId: string;
104
+ userId: string;
105
+ }
96
106
  export interface GetCourseListRequest {
97
107
  page?: number;
98
108
  pageSize?: number;
@@ -138,6 +148,13 @@ export interface PostCourseImageUploadRequest {
138
148
  courseId: string;
139
149
  file: Blob;
140
150
  }
151
+ export interface PostCourseItemLearnerSessionsClearRequest {
152
+ courseId: string;
153
+ courseVersionId: string;
154
+ itemId: string;
155
+ userId: string;
156
+ postClearSessions: PostClearSessions;
157
+ }
141
158
  export interface PostCourseResumeRequest {
142
159
  courseId: string;
143
160
  }
@@ -175,6 +192,13 @@ export interface PutCourseEnrollmentRequest {
175
192
  enrollmentId: string;
176
193
  putCourseEnrollment: PutCourseEnrollment;
177
194
  }
195
+ export interface PutCourseItemLearnerAttemptAllowanceRequest {
196
+ courseId: string;
197
+ courseVersionId: string;
198
+ itemId: string;
199
+ userId: string;
200
+ putAttemptAllowance: PutAttemptAllowance;
201
+ }
178
202
  export interface PutCourseVersionItemRequest {
179
203
  courseId: string;
180
204
  sectionId: string;
@@ -352,6 +376,18 @@ export declare class CourseApi extends runtime.BaseAPI {
352
376
  * List all SCORM exports for a course
353
377
  */
354
378
  getCourseExports(requestParameters: GetCourseExportsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExportList>;
379
+ /**
380
+ * Creates request options for getCourseItemLearnerAttemptAllowance without sending the request
381
+ */
382
+ getCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters: GetCourseItemLearnerAttemptAllowanceRequest): Promise<runtime.RequestOpts>;
383
+ /**
384
+ * Get a learner\'s effective attempt limit for a course item
385
+ */
386
+ getCourseItemLearnerAttemptAllowanceRaw(requestParameters: GetCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttemptAllowance>>;
387
+ /**
388
+ * Get a learner\'s effective attempt limit for a course item
389
+ */
390
+ getCourseItemLearnerAttemptAllowance(requestParameters: GetCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttemptAllowance>;
355
391
  /**
356
392
  * Creates request options for getCourseList without sending the request
357
393
  */
@@ -488,6 +524,18 @@ export declare class CourseApi extends runtime.BaseAPI {
488
524
  * Upload a course image
489
525
  */
490
526
  postCourseImageUpload(requestParameters: PostCourseImageUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseImageUpload>;
527
+ /**
528
+ * Creates request options for postCourseItemLearnerSessionsClear without sending the request
529
+ */
530
+ postCourseItemLearnerSessionsClearRequestOpts(requestParameters: PostCourseItemLearnerSessionsClearRequest): Promise<runtime.RequestOpts>;
531
+ /**
532
+ * Clear all live sessions for a learner and course item
533
+ */
534
+ postCourseItemLearnerSessionsClearRaw(requestParameters: PostCourseItemLearnerSessionsClearRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostClearSessionsResponse>>;
535
+ /**
536
+ * Clear all live sessions for a learner and course item
537
+ */
538
+ postCourseItemLearnerSessionsClear(requestParameters: PostCourseItemLearnerSessionsClearRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostClearSessionsResponse>;
491
539
  /**
492
540
  * Creates request options for postCourseResume without sending the request
493
541
  */
@@ -586,6 +634,18 @@ export declare class CourseApi extends runtime.BaseAPI {
586
634
  * Update a course enrollment
587
635
  */
588
636
  putCourseEnrollment(requestParameters: PutCourseEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseEnrollment>;
637
+ /**
638
+ * Creates request options for putCourseItemLearnerAttemptAllowance without sending the request
639
+ */
640
+ putCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters: PutCourseItemLearnerAttemptAllowanceRequest): Promise<runtime.RequestOpts>;
641
+ /**
642
+ * Set extra attempts for a learner on a course item
643
+ */
644
+ putCourseItemLearnerAttemptAllowanceRaw(requestParameters: PutCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttemptAllowance>>;
645
+ /**
646
+ * Set extra attempts for a learner on a course item
647
+ */
648
+ putCourseItemLearnerAttemptAllowance(requestParameters: PutCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttemptAllowance>;
589
649
  /**
590
650
  * Creates request options for putCourseVersionItem without sending the request
591
651
  */
@@ -21,6 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
+ import { GetAttemptAllowanceFromJSON, } from '../models/GetAttemptAllowance';
24
25
  import { GetCourseFromJSON, } from '../models/GetCourse';
25
26
  import { GetCourseEnrollmentFromJSON, } from '../models/GetCourseEnrollment';
26
27
  import { GetCourseEnrollmentListFromJSON, } from '../models/GetCourseEnrollmentList';
@@ -34,6 +35,8 @@ import { GetCourseVersionItemLaunchFromJSON, } from '../models/GetCourseVersionI
34
35
  import { GetCourseVersionItemSessionFromJSON, } from '../models/GetCourseVersionItemSession';
35
36
  import { GetCourseVersionListFromJSON, } from '../models/GetCourseVersionList';
36
37
  import { GetCourseVersionSectionFromJSON, } from '../models/GetCourseVersionSection';
38
+ import { PostClearSessionsToJSON, } from '../models/PostClearSessions';
39
+ import { PostClearSessionsResponseFromJSON, } from '../models/PostClearSessionsResponse';
37
40
  import { PostCourseToJSON, } from '../models/PostCourse';
38
41
  import { PostCourseDraftToJSON, } from '../models/PostCourseDraft';
39
42
  import { PostCourseEnrollmentToJSON, } from '../models/PostCourseEnrollment';
@@ -45,6 +48,7 @@ import { PostCourseVersionPublishToJSON, } from '../models/PostCourseVersionPubl
45
48
  import { PostCourseVersionSectionToJSON, } from '../models/PostCourseVersionSection';
46
49
  import { PostCourseVersionSectionDuplicateToJSON, } from '../models/PostCourseVersionSectionDuplicate';
47
50
  import { PostDuplicateToJSON, } from '../models/PostDuplicate';
51
+ import { PutAttemptAllowanceToJSON, } from '../models/PutAttemptAllowance';
48
52
  import { PutCourseToJSON, } from '../models/PutCourse';
49
53
  import { PutCourseEnrollmentToJSON, } from '../models/PutCourseEnrollment';
50
54
  import { PutCourseVersionItemToJSON, } from '../models/PutCourseVersionItem';
@@ -610,6 +614,57 @@ export class CourseApi extends runtime.BaseAPI {
610
614
  return yield response.value();
611
615
  });
612
616
  }
617
+ /**
618
+ * Creates request options for getCourseItemLearnerAttemptAllowance without sending the request
619
+ */
620
+ getCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters) {
621
+ return __awaiter(this, void 0, void 0, function* () {
622
+ if (requestParameters['courseId'] == null) {
623
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().');
624
+ }
625
+ if (requestParameters['courseVersionId'] == null) {
626
+ throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().');
627
+ }
628
+ if (requestParameters['itemId'] == null) {
629
+ throw new runtime.RequiredError('itemId', 'Required parameter "itemId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().');
630
+ }
631
+ if (requestParameters['userId'] == null) {
632
+ throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().');
633
+ }
634
+ const queryParameters = {};
635
+ const headerParameters = {};
636
+ let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance`;
637
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
638
+ urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
639
+ urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
640
+ urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
641
+ return {
642
+ path: urlPath,
643
+ method: 'GET',
644
+ headers: headerParameters,
645
+ query: queryParameters,
646
+ };
647
+ });
648
+ }
649
+ /**
650
+ * Get a learner\'s effective attempt limit for a course item
651
+ */
652
+ getCourseItemLearnerAttemptAllowanceRaw(requestParameters, initOverrides) {
653
+ return __awaiter(this, void 0, void 0, function* () {
654
+ const requestOptions = yield this.getCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters);
655
+ const response = yield this.request(requestOptions, initOverrides);
656
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetAttemptAllowanceFromJSON(jsonValue));
657
+ });
658
+ }
659
+ /**
660
+ * Get a learner\'s effective attempt limit for a course item
661
+ */
662
+ getCourseItemLearnerAttemptAllowance(requestParameters, initOverrides) {
663
+ return __awaiter(this, void 0, void 0, function* () {
664
+ const response = yield this.getCourseItemLearnerAttemptAllowanceRaw(requestParameters, initOverrides);
665
+ return yield response.value();
666
+ });
667
+ }
613
668
  /**
614
669
  * Creates request options for getCourseList without sending the request
615
670
  */
@@ -1103,6 +1158,62 @@ export class CourseApi extends runtime.BaseAPI {
1103
1158
  return yield response.value();
1104
1159
  });
1105
1160
  }
1161
+ /**
1162
+ * Creates request options for postCourseItemLearnerSessionsClear without sending the request
1163
+ */
1164
+ postCourseItemLearnerSessionsClearRequestOpts(requestParameters) {
1165
+ return __awaiter(this, void 0, void 0, function* () {
1166
+ if (requestParameters['courseId'] == null) {
1167
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling postCourseItemLearnerSessionsClear().');
1168
+ }
1169
+ if (requestParameters['courseVersionId'] == null) {
1170
+ throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling postCourseItemLearnerSessionsClear().');
1171
+ }
1172
+ if (requestParameters['itemId'] == null) {
1173
+ throw new runtime.RequiredError('itemId', 'Required parameter "itemId" was null or undefined when calling postCourseItemLearnerSessionsClear().');
1174
+ }
1175
+ if (requestParameters['userId'] == null) {
1176
+ throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling postCourseItemLearnerSessionsClear().');
1177
+ }
1178
+ if (requestParameters['postClearSessions'] == null) {
1179
+ throw new runtime.RequiredError('postClearSessions', 'Required parameter "postClearSessions" was null or undefined when calling postCourseItemLearnerSessionsClear().');
1180
+ }
1181
+ const queryParameters = {};
1182
+ const headerParameters = {};
1183
+ headerParameters['Content-Type'] = 'application/json';
1184
+ let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/sessions/clear`;
1185
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
1186
+ urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
1187
+ urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
1188
+ urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
1189
+ return {
1190
+ path: urlPath,
1191
+ method: 'POST',
1192
+ headers: headerParameters,
1193
+ query: queryParameters,
1194
+ body: PostClearSessionsToJSON(requestParameters['postClearSessions']),
1195
+ };
1196
+ });
1197
+ }
1198
+ /**
1199
+ * Clear all live sessions for a learner and course item
1200
+ */
1201
+ postCourseItemLearnerSessionsClearRaw(requestParameters, initOverrides) {
1202
+ return __awaiter(this, void 0, void 0, function* () {
1203
+ const requestOptions = yield this.postCourseItemLearnerSessionsClearRequestOpts(requestParameters);
1204
+ const response = yield this.request(requestOptions, initOverrides);
1205
+ return new runtime.JSONApiResponse(response, (jsonValue) => PostClearSessionsResponseFromJSON(jsonValue));
1206
+ });
1207
+ }
1208
+ /**
1209
+ * Clear all live sessions for a learner and course item
1210
+ */
1211
+ postCourseItemLearnerSessionsClear(requestParameters, initOverrides) {
1212
+ return __awaiter(this, void 0, void 0, function* () {
1213
+ const response = yield this.postCourseItemLearnerSessionsClearRaw(requestParameters, initOverrides);
1214
+ return yield response.value();
1215
+ });
1216
+ }
1106
1217
  /**
1107
1218
  * Creates request options for postCourseResume without sending the request
1108
1219
  */
@@ -1474,6 +1585,62 @@ export class CourseApi extends runtime.BaseAPI {
1474
1585
  return yield response.value();
1475
1586
  });
1476
1587
  }
1588
+ /**
1589
+ * Creates request options for putCourseItemLearnerAttemptAllowance without sending the request
1590
+ */
1591
+ putCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters) {
1592
+ return __awaiter(this, void 0, void 0, function* () {
1593
+ if (requestParameters['courseId'] == null) {
1594
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().');
1595
+ }
1596
+ if (requestParameters['courseVersionId'] == null) {
1597
+ throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().');
1598
+ }
1599
+ if (requestParameters['itemId'] == null) {
1600
+ throw new runtime.RequiredError('itemId', 'Required parameter "itemId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().');
1601
+ }
1602
+ if (requestParameters['userId'] == null) {
1603
+ throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().');
1604
+ }
1605
+ if (requestParameters['putAttemptAllowance'] == null) {
1606
+ throw new runtime.RequiredError('putAttemptAllowance', 'Required parameter "putAttemptAllowance" was null or undefined when calling putCourseItemLearnerAttemptAllowance().');
1607
+ }
1608
+ const queryParameters = {};
1609
+ const headerParameters = {};
1610
+ headerParameters['Content-Type'] = 'application/json';
1611
+ let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance`;
1612
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
1613
+ urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
1614
+ urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
1615
+ urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
1616
+ return {
1617
+ path: urlPath,
1618
+ method: 'PUT',
1619
+ headers: headerParameters,
1620
+ query: queryParameters,
1621
+ body: PutAttemptAllowanceToJSON(requestParameters['putAttemptAllowance']),
1622
+ };
1623
+ });
1624
+ }
1625
+ /**
1626
+ * Set extra attempts for a learner on a course item
1627
+ */
1628
+ putCourseItemLearnerAttemptAllowanceRaw(requestParameters, initOverrides) {
1629
+ return __awaiter(this, void 0, void 0, function* () {
1630
+ const requestOptions = yield this.putCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters);
1631
+ const response = yield this.request(requestOptions, initOverrides);
1632
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetAttemptAllowanceFromJSON(jsonValue));
1633
+ });
1634
+ }
1635
+ /**
1636
+ * Set extra attempts for a learner on a course item
1637
+ */
1638
+ putCourseItemLearnerAttemptAllowance(requestParameters, initOverrides) {
1639
+ return __awaiter(this, void 0, void 0, function* () {
1640
+ const response = yield this.putCourseItemLearnerAttemptAllowanceRaw(requestParameters, initOverrides);
1641
+ return yield response.value();
1642
+ });
1643
+ }
1477
1644
  /**
1478
1645
  * Creates request options for putCourseVersionItem without sending the request
1479
1646
  */
@@ -11,10 +11,15 @@
11
11
  */
12
12
  import * as runtime from '../runtime';
13
13
  import { type GetResourceSession } from '../models/GetResourceSession';
14
+ import { type GetResourceSessionActivity } from '../models/GetResourceSessionActivity';
15
+ import { type GetResourceSessionActivityEventList } from '../models/GetResourceSessionActivityEventList';
16
+ import { type GetResourceSessionActivityList } from '../models/GetResourceSessionActivityList';
14
17
  import { type GetResourceSessionDiagnostics } from '../models/GetResourceSessionDiagnostics';
15
18
  import { type GetResourceSessionList } from '../models/GetResourceSessionList';
16
19
  import { type GetResourceSessionScormApiLogs } from '../models/GetResourceSessionScormApiLogs';
17
20
  import { type GetResourceSessionScormData } from '../models/GetResourceSessionScormData';
21
+ import { type PostResourceSessionActivityEvent } from '../models/PostResourceSessionActivityEvent';
22
+ import { type PutResourceSessionOverride } from '../models/PutResourceSessionOverride';
18
23
  import { type ResourceSessionEnvironment } from '../models/ResourceSessionEnvironment';
19
24
  import { type ResourceType } from '../models/ResourceType';
20
25
  import { type ScormGetValueResponse } from '../models/ScormGetValueResponse';
@@ -22,6 +27,7 @@ import { type ScormSetValueRequest } from '../models/ScormSetValueRequest';
22
27
  import { type ScormSetValueResponse } from '../models/ScormSetValueResponse';
23
28
  export interface CommitResourceScormSessionRequest {
24
29
  sessionId: string;
30
+ activityId?: string;
25
31
  }
26
32
  export interface GetCourseVersionResourceAssetRequest {
27
33
  courseVersionId: string;
@@ -34,10 +40,17 @@ export interface GetLibraryQuizSessionPlayerRequest {
34
40
  export interface GetResourceScormValueRequest {
35
41
  sessionId: string;
36
42
  key: string;
43
+ activityId?: string;
37
44
  }
38
45
  export interface GetResourceSessionRequest {
39
46
  sessionId: string;
40
47
  }
48
+ export interface GetResourceSessionActivitiesRequest {
49
+ sessionId: string;
50
+ }
51
+ export interface GetResourceSessionActivityEventsRequest {
52
+ sessionId: string;
53
+ }
41
54
  export interface GetResourceSessionAssetRequest {
42
55
  sessionId: string;
43
56
  assetPath: string;
@@ -81,19 +94,32 @@ export interface GetResourceSessionScormApiLogsRequest {
81
94
  }
82
95
  export interface GetResourceSessionScormDataRequest {
83
96
  sessionId: string;
97
+ activityId?: string;
84
98
  }
85
99
  export interface InitializeResourceScormSessionRequest {
86
100
  sessionId: string;
101
+ activityId?: string;
102
+ }
103
+ export interface PostResourceSessionActivityEventRequest {
104
+ sessionId: string;
105
+ activityId: string;
106
+ postResourceSessionActivityEvent: PostResourceSessionActivityEvent;
87
107
  }
88
108
  export interface PostResourceSessionCompleteRequest {
89
109
  sessionId: string;
90
110
  }
111
+ export interface PutResourceSessionOverrideRequest {
112
+ sessionId: string;
113
+ putResourceSessionOverride: PutResourceSessionOverride;
114
+ }
91
115
  export interface SetResourceScormValueRequest {
92
116
  sessionId: string;
93
117
  scormSetValueRequest: ScormSetValueRequest;
118
+ activityId?: string;
94
119
  }
95
120
  export interface TerminateResourceScormSessionRequest {
96
121
  sessionId: string;
122
+ activityId?: string;
97
123
  }
98
124
  /**
99
125
  *
@@ -159,6 +185,30 @@ export declare class PlayerApi extends runtime.BaseAPI {
159
185
  * Get a resource session
160
186
  */
161
187
  getResourceSession(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
188
+ /**
189
+ * Creates request options for getResourceSessionActivities without sending the request
190
+ */
191
+ getResourceSessionActivitiesRequestOpts(requestParameters: GetResourceSessionActivitiesRequest): Promise<runtime.RequestOpts>;
192
+ /**
193
+ * List tracked activities for a resource session
194
+ */
195
+ getResourceSessionActivitiesRaw(requestParameters: GetResourceSessionActivitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionActivityList>>;
196
+ /**
197
+ * List tracked activities for a resource session
198
+ */
199
+ getResourceSessionActivities(requestParameters: GetResourceSessionActivitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionActivityList>;
200
+ /**
201
+ * Creates request options for getResourceSessionActivityEvents without sending the request
202
+ */
203
+ getResourceSessionActivityEventsRequestOpts(requestParameters: GetResourceSessionActivityEventsRequest): Promise<runtime.RequestOpts>;
204
+ /**
205
+ * List recorded learner activity events for a resource session
206
+ */
207
+ getResourceSessionActivityEventsRaw(requestParameters: GetResourceSessionActivityEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionActivityEventList>>;
208
+ /**
209
+ * List recorded learner activity events for a resource session
210
+ */
211
+ getResourceSessionActivityEvents(requestParameters: GetResourceSessionActivityEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionActivityEventList>;
162
212
  /**
163
213
  * Creates request options for getResourceSessionAsset without sending the request
164
214
  */
@@ -243,6 +293,18 @@ export declare class PlayerApi extends runtime.BaseAPI {
243
293
  * Initialize a reusable SCORM resource session
244
294
  */
245
295
  initializeResourceScormSession(requestParameters: InitializeResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
296
+ /**
297
+ * Creates request options for postResourceSessionActivityEvent without sending the request
298
+ */
299
+ postResourceSessionActivityEventRequestOpts(requestParameters: PostResourceSessionActivityEventRequest): Promise<runtime.RequestOpts>;
300
+ /**
301
+ * Record learner activity and update active time
302
+ */
303
+ postResourceSessionActivityEventRaw(requestParameters: PostResourceSessionActivityEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionActivity>>;
304
+ /**
305
+ * Record learner activity and update active time
306
+ */
307
+ postResourceSessionActivityEvent(requestParameters: PostResourceSessionActivityEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionActivity>;
246
308
  /**
247
309
  * Creates request options for postResourceSessionComplete without sending the request
248
310
  */
@@ -255,6 +317,18 @@ export declare class PlayerApi extends runtime.BaseAPI {
255
317
  * Complete a non-SCORM resource session
256
318
  */
257
319
  postResourceSessionComplete(requestParameters: PostResourceSessionCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
320
+ /**
321
+ * Creates request options for putResourceSessionOverride without sending the request
322
+ */
323
+ putResourceSessionOverrideRequestOpts(requestParameters: PutResourceSessionOverrideRequest): Promise<runtime.RequestOpts>;
324
+ /**
325
+ * Override a learner\'s live resource-session progress
326
+ */
327
+ putResourceSessionOverrideRaw(requestParameters: PutResourceSessionOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>>;
328
+ /**
329
+ * Override a learner\'s live resource-session progress
330
+ */
331
+ putResourceSessionOverride(requestParameters: PutResourceSessionOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
258
332
  /**
259
333
  * Creates request options for setResourceScormValue without sending the request
260
334
  */