@easyedu/js-lsm-api 1.99.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 (62) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/README.md +13 -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 +17 -0
  8. package/dist/apis/PlayerApi.js +45 -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 +17 -0
  14. package/dist/esm/apis/PlayerApi.js +45 -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/PostClearSessions.d.ts +32 -0
  18. package/dist/esm/models/PostClearSessions.js +43 -0
  19. package/dist/esm/models/PostClearSessionsResponse.d.ts +44 -0
  20. package/dist/esm/models/PostClearSessionsResponse.js +51 -0
  21. package/dist/esm/models/PutAttemptAllowance.d.ts +38 -0
  22. package/dist/esm/models/PutAttemptAllowance.js +47 -0
  23. package/dist/esm/models/PutLibraryQuizSessionOverride.d.ts +57 -0
  24. package/dist/esm/models/PutLibraryQuizSessionOverride.js +55 -0
  25. package/dist/esm/models/PutResourceSessionOverride.d.ts +69 -0
  26. package/dist/esm/models/PutResourceSessionOverride.js +66 -0
  27. package/dist/esm/models/index.d.ts +6 -0
  28. package/dist/esm/models/index.js +6 -0
  29. package/dist/models/GetAttemptAllowance.d.ts +80 -0
  30. package/dist/models/GetAttemptAllowance.js +82 -0
  31. package/dist/models/PostClearSessions.d.ts +32 -0
  32. package/dist/models/PostClearSessions.js +50 -0
  33. package/dist/models/PostClearSessionsResponse.d.ts +44 -0
  34. package/dist/models/PostClearSessionsResponse.js +58 -0
  35. package/dist/models/PutAttemptAllowance.d.ts +38 -0
  36. package/dist/models/PutAttemptAllowance.js +54 -0
  37. package/dist/models/PutLibraryQuizSessionOverride.d.ts +57 -0
  38. package/dist/models/PutLibraryQuizSessionOverride.js +63 -0
  39. package/dist/models/PutResourceSessionOverride.d.ts +69 -0
  40. package/dist/models/PutResourceSessionOverride.js +74 -0
  41. package/dist/models/index.d.ts +6 -0
  42. package/dist/models/index.js +6 -0
  43. package/docs/ContentLibraryQuizApi.md +71 -0
  44. package/docs/CourseApi.md +236 -0
  45. package/docs/GetAttemptAllowance.md +51 -0
  46. package/docs/PlayerApi.md +71 -0
  47. package/docs/PostClearSessions.md +34 -0
  48. package/docs/PostClearSessionsResponse.md +38 -0
  49. package/docs/PutAttemptAllowance.md +36 -0
  50. package/docs/PutLibraryQuizSessionOverride.md +41 -0
  51. package/docs/PutResourceSessionOverride.md +41 -0
  52. package/package.json +1 -1
  53. package/src/apis/ContentLibraryQuizApi.ts +65 -0
  54. package/src/apis/CourseApi.ts +270 -0
  55. package/src/apis/PlayerApi.ts +65 -0
  56. package/src/models/GetAttemptAllowance.ts +138 -0
  57. package/src/models/PostClearSessions.ts +66 -0
  58. package/src/models/PostClearSessionsResponse.ts +84 -0
  59. package/src/models/PutAttemptAllowance.ts +75 -0
  60. package/src/models/PutLibraryQuizSessionOverride.ts +100 -0
  61. package/src/models/PutResourceSessionOverride.ts +113 -0
  62. package/src/models/index.ts +6 -0
@@ -33,6 +33,7 @@ const GetResourceSessionList_1 = require("../models/GetResourceSessionList");
33
33
  const GetResourceSessionScormApiLogs_1 = require("../models/GetResourceSessionScormApiLogs");
34
34
  const GetResourceSessionScormData_1 = require("../models/GetResourceSessionScormData");
35
35
  const PostResourceSessionActivityEvent_1 = require("../models/PostResourceSessionActivityEvent");
36
+ const PutResourceSessionOverride_1 = require("../models/PutResourceSessionOverride");
36
37
  const ScormGetValueResponse_1 = require("../models/ScormGetValueResponse");
37
38
  const ScormSetValueRequest_1 = require("../models/ScormSetValueRequest");
38
39
  const ScormSetValueResponse_1 = require("../models/ScormSetValueResponse");
@@ -785,6 +786,50 @@ class PlayerApi extends runtime.BaseAPI {
785
786
  return yield response.value();
786
787
  });
787
788
  }
789
+ /**
790
+ * Creates request options for putResourceSessionOverride without sending the request
791
+ */
792
+ putResourceSessionOverrideRequestOpts(requestParameters) {
793
+ return __awaiter(this, void 0, void 0, function* () {
794
+ if (requestParameters['sessionId'] == null) {
795
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling putResourceSessionOverride().');
796
+ }
797
+ if (requestParameters['putResourceSessionOverride'] == null) {
798
+ throw new runtime.RequiredError('putResourceSessionOverride', 'Required parameter "putResourceSessionOverride" was null or undefined when calling putResourceSessionOverride().');
799
+ }
800
+ const queryParameters = {};
801
+ const headerParameters = {};
802
+ headerParameters['Content-Type'] = 'application/json';
803
+ let urlPath = `/resource/sessions/{sessionId}/override`;
804
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
805
+ return {
806
+ path: urlPath,
807
+ method: 'PUT',
808
+ headers: headerParameters,
809
+ query: queryParameters,
810
+ body: (0, PutResourceSessionOverride_1.PutResourceSessionOverrideToJSON)(requestParameters['putResourceSessionOverride']),
811
+ };
812
+ });
813
+ }
814
+ /**
815
+ * Override a learner\'s live resource-session progress
816
+ */
817
+ putResourceSessionOverrideRaw(requestParameters, initOverrides) {
818
+ return __awaiter(this, void 0, void 0, function* () {
819
+ const requestOptions = yield this.putResourceSessionOverrideRequestOpts(requestParameters);
820
+ const response = yield this.request(requestOptions, initOverrides);
821
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSession_1.GetResourceSessionFromJSON)(jsonValue));
822
+ });
823
+ }
824
+ /**
825
+ * Override a learner\'s live resource-session progress
826
+ */
827
+ putResourceSessionOverride(requestParameters, initOverrides) {
828
+ return __awaiter(this, void 0, void 0, function* () {
829
+ const response = yield this.putResourceSessionOverrideRaw(requestParameters, initOverrides);
830
+ return yield response.value();
831
+ });
832
+ }
788
833
  /**
789
834
  * Creates request options for setResourceScormValue without sending the request
790
835
  */
@@ -30,6 +30,7 @@ import { type PutLibraryQuizCriteria } from '../models/PutLibraryQuizCriteria';
30
30
  import { type PutLibraryQuizQuestions } from '../models/PutLibraryQuizQuestions';
31
31
  import { type PutLibraryQuizSessionAnswer } from '../models/PutLibraryQuizSessionAnswer';
32
32
  import { type PutLibraryQuizSessionGrade } from '../models/PutLibraryQuizSessionGrade';
33
+ import { type PutLibraryQuizSessionOverride } from '../models/PutLibraryQuizSessionOverride';
33
34
  import { type PutLibraryQuizVersion } from '../models/PutLibraryQuizVersion';
34
35
  import { type ResourceSessionEnvironment } from '../models/ResourceSessionEnvironment';
35
36
  export interface DeleteLibraryQuizVersionRequest {
@@ -145,6 +146,10 @@ export interface PutLibraryQuizSessionGradeRequest {
145
146
  sessionQuestionId: string;
146
147
  putLibraryQuizSessionGrade: PutLibraryQuizSessionGrade;
147
148
  }
149
+ export interface PutLibraryQuizSessionOverrideRequest {
150
+ sessionId: string;
151
+ putLibraryQuizSessionOverride: PutLibraryQuizSessionOverride;
152
+ }
148
153
  export interface PutLibraryQuizVersionRequest {
149
154
  quizId: string;
150
155
  versionId: string;
@@ -454,6 +459,18 @@ export declare class ContentLibraryQuizApi extends runtime.BaseAPI {
454
459
  * Manually grade a reusable quiz session answer
455
460
  */
456
461
  putLibraryQuizSessionGrade(requestParameters: PutLibraryQuizSessionGradeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLibraryQuizResult>;
462
+ /**
463
+ * Creates request options for putLibraryQuizSessionOverride without sending the request
464
+ */
465
+ putLibraryQuizSessionOverrideRequestOpts(requestParameters: PutLibraryQuizSessionOverrideRequest): Promise<runtime.RequestOpts>;
466
+ /**
467
+ * Override a learner\'s live quiz-session progress
468
+ */
469
+ putLibraryQuizSessionOverrideRaw(requestParameters: PutLibraryQuizSessionOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLibraryQuizSession>>;
470
+ /**
471
+ * Override a learner\'s live quiz-session progress
472
+ */
473
+ putLibraryQuizSessionOverride(requestParameters: PutLibraryQuizSessionOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLibraryQuizSession>;
457
474
  /**
458
475
  * Creates request options for putLibraryQuizVersion without sending the request
459
476
  */
@@ -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
  */
@@ -19,6 +19,7 @@ import { type GetResourceSessionList } from '../models/GetResourceSessionList';
19
19
  import { type GetResourceSessionScormApiLogs } from '../models/GetResourceSessionScormApiLogs';
20
20
  import { type GetResourceSessionScormData } from '../models/GetResourceSessionScormData';
21
21
  import { type PostResourceSessionActivityEvent } from '../models/PostResourceSessionActivityEvent';
22
+ import { type PutResourceSessionOverride } from '../models/PutResourceSessionOverride';
22
23
  import { type ResourceSessionEnvironment } from '../models/ResourceSessionEnvironment';
23
24
  import { type ResourceType } from '../models/ResourceType';
24
25
  import { type ScormGetValueResponse } from '../models/ScormGetValueResponse';
@@ -107,6 +108,10 @@ export interface PostResourceSessionActivityEventRequest {
107
108
  export interface PostResourceSessionCompleteRequest {
108
109
  sessionId: string;
109
110
  }
111
+ export interface PutResourceSessionOverrideRequest {
112
+ sessionId: string;
113
+ putResourceSessionOverride: PutResourceSessionOverride;
114
+ }
110
115
  export interface SetResourceScormValueRequest {
111
116
  sessionId: string;
112
117
  scormSetValueRequest: ScormSetValueRequest;
@@ -312,6 +317,18 @@ export declare class PlayerApi extends runtime.BaseAPI {
312
317
  * Complete a non-SCORM resource session
313
318
  */
314
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>;
315
332
  /**
316
333
  * Creates request options for setResourceScormValue without sending the request
317
334
  */
@@ -30,6 +30,7 @@ import { GetResourceSessionListFromJSON, } from '../models/GetResourceSessionLis
30
30
  import { GetResourceSessionScormApiLogsFromJSON, } from '../models/GetResourceSessionScormApiLogs';
31
31
  import { GetResourceSessionScormDataFromJSON, } from '../models/GetResourceSessionScormData';
32
32
  import { PostResourceSessionActivityEventToJSON, } from '../models/PostResourceSessionActivityEvent';
33
+ import { PutResourceSessionOverrideToJSON, } from '../models/PutResourceSessionOverride';
33
34
  import { ScormGetValueResponseFromJSON, } from '../models/ScormGetValueResponse';
34
35
  import { ScormSetValueRequestToJSON, } from '../models/ScormSetValueRequest';
35
36
  import { ScormSetValueResponseFromJSON, } from '../models/ScormSetValueResponse';
@@ -782,6 +783,50 @@ export class PlayerApi extends runtime.BaseAPI {
782
783
  return yield response.value();
783
784
  });
784
785
  }
786
+ /**
787
+ * Creates request options for putResourceSessionOverride without sending the request
788
+ */
789
+ putResourceSessionOverrideRequestOpts(requestParameters) {
790
+ return __awaiter(this, void 0, void 0, function* () {
791
+ if (requestParameters['sessionId'] == null) {
792
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling putResourceSessionOverride().');
793
+ }
794
+ if (requestParameters['putResourceSessionOverride'] == null) {
795
+ throw new runtime.RequiredError('putResourceSessionOverride', 'Required parameter "putResourceSessionOverride" was null or undefined when calling putResourceSessionOverride().');
796
+ }
797
+ const queryParameters = {};
798
+ const headerParameters = {};
799
+ headerParameters['Content-Type'] = 'application/json';
800
+ let urlPath = `/resource/sessions/{sessionId}/override`;
801
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
802
+ return {
803
+ path: urlPath,
804
+ method: 'PUT',
805
+ headers: headerParameters,
806
+ query: queryParameters,
807
+ body: PutResourceSessionOverrideToJSON(requestParameters['putResourceSessionOverride']),
808
+ };
809
+ });
810
+ }
811
+ /**
812
+ * Override a learner\'s live resource-session progress
813
+ */
814
+ putResourceSessionOverrideRaw(requestParameters, initOverrides) {
815
+ return __awaiter(this, void 0, void 0, function* () {
816
+ const requestOptions = yield this.putResourceSessionOverrideRequestOpts(requestParameters);
817
+ const response = yield this.request(requestOptions, initOverrides);
818
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionFromJSON(jsonValue));
819
+ });
820
+ }
821
+ /**
822
+ * Override a learner\'s live resource-session progress
823
+ */
824
+ putResourceSessionOverride(requestParameters, initOverrides) {
825
+ return __awaiter(this, void 0, void 0, function* () {
826
+ const response = yield this.putResourceSessionOverrideRaw(requestParameters, initOverrides);
827
+ return yield response.value();
828
+ });
829
+ }
785
830
  /**
786
831
  * Creates request options for setResourceScormValue without sending the request
787
832
  */
@@ -0,0 +1,80 @@
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
+ * The effective attempt limit for one learner and course-version item.
14
+ * @export
15
+ * @interface GetAttemptAllowance
16
+ */
17
+ export interface GetAttemptAllowance {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof GetAttemptAllowance
22
+ */
23
+ courseId: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof GetAttemptAllowance
28
+ */
29
+ courseVersionId: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof GetAttemptAllowance
34
+ */
35
+ itemId: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof GetAttemptAllowance
40
+ */
41
+ userId: string;
42
+ /**
43
+ *
44
+ * @type {number}
45
+ * @memberof GetAttemptAllowance
46
+ */
47
+ baseMaxAttempts: number;
48
+ /**
49
+ *
50
+ * @type {number}
51
+ * @memberof GetAttemptAllowance
52
+ */
53
+ additionalAttempts: number;
54
+ /**
55
+ *
56
+ * @type {number}
57
+ * @memberof GetAttemptAllowance
58
+ */
59
+ effectiveMaxAttempts: number;
60
+ /**
61
+ *
62
+ * @type {number}
63
+ * @memberof GetAttemptAllowance
64
+ */
65
+ attemptsUsed: number;
66
+ /**
67
+ *
68
+ * @type {number}
69
+ * @memberof GetAttemptAllowance
70
+ */
71
+ attemptsRemaining: number;
72
+ }
73
+ /**
74
+ * Check if a given object implements the GetAttemptAllowance interface.
75
+ */
76
+ export declare function instanceOfGetAttemptAllowance(value: object): value is GetAttemptAllowance;
77
+ export declare function GetAttemptAllowanceFromJSON(json: any): GetAttemptAllowance;
78
+ export declare function GetAttemptAllowanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetAttemptAllowance;
79
+ export declare function GetAttemptAllowanceToJSON(json: any): GetAttemptAllowance;
80
+ export declare function GetAttemptAllowanceToJSONTyped(value?: GetAttemptAllowance | null, ignoreDiscriminator?: boolean): any;