@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
@@ -24,6 +24,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
25
  exports.GetCourseEnrollmentsTypeEnum = exports.CourseApi = void 0;
26
26
  const runtime = require("../runtime");
27
+ const GetAttemptAllowance_1 = require("../models/GetAttemptAllowance");
27
28
  const GetCourse_1 = require("../models/GetCourse");
28
29
  const GetCourseEnrollment_1 = require("../models/GetCourseEnrollment");
29
30
  const GetCourseEnrollmentList_1 = require("../models/GetCourseEnrollmentList");
@@ -37,6 +38,8 @@ const GetCourseVersionItemLaunch_1 = require("../models/GetCourseVersionItemLaun
37
38
  const GetCourseVersionItemSession_1 = require("../models/GetCourseVersionItemSession");
38
39
  const GetCourseVersionList_1 = require("../models/GetCourseVersionList");
39
40
  const GetCourseVersionSection_1 = require("../models/GetCourseVersionSection");
41
+ const PostClearSessions_1 = require("../models/PostClearSessions");
42
+ const PostClearSessionsResponse_1 = require("../models/PostClearSessionsResponse");
40
43
  const PostCourse_1 = require("../models/PostCourse");
41
44
  const PostCourseDraft_1 = require("../models/PostCourseDraft");
42
45
  const PostCourseEnrollment_1 = require("../models/PostCourseEnrollment");
@@ -48,6 +51,7 @@ const PostCourseVersionPublish_1 = require("../models/PostCourseVersionPublish")
48
51
  const PostCourseVersionSection_1 = require("../models/PostCourseVersionSection");
49
52
  const PostCourseVersionSectionDuplicate_1 = require("../models/PostCourseVersionSectionDuplicate");
50
53
  const PostDuplicate_1 = require("../models/PostDuplicate");
54
+ const PutAttemptAllowance_1 = require("../models/PutAttemptAllowance");
51
55
  const PutCourse_1 = require("../models/PutCourse");
52
56
  const PutCourseEnrollment_1 = require("../models/PutCourseEnrollment");
53
57
  const PutCourseVersionItem_1 = require("../models/PutCourseVersionItem");
@@ -613,6 +617,57 @@ class CourseApi extends runtime.BaseAPI {
613
617
  return yield response.value();
614
618
  });
615
619
  }
620
+ /**
621
+ * Creates request options for getCourseItemLearnerAttemptAllowance without sending the request
622
+ */
623
+ getCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters) {
624
+ return __awaiter(this, void 0, void 0, function* () {
625
+ if (requestParameters['courseId'] == null) {
626
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().');
627
+ }
628
+ if (requestParameters['courseVersionId'] == null) {
629
+ throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().');
630
+ }
631
+ if (requestParameters['itemId'] == null) {
632
+ throw new runtime.RequiredError('itemId', 'Required parameter "itemId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().');
633
+ }
634
+ if (requestParameters['userId'] == null) {
635
+ throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().');
636
+ }
637
+ const queryParameters = {};
638
+ const headerParameters = {};
639
+ let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance`;
640
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
641
+ urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
642
+ urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
643
+ urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
644
+ return {
645
+ path: urlPath,
646
+ method: 'GET',
647
+ headers: headerParameters,
648
+ query: queryParameters,
649
+ };
650
+ });
651
+ }
652
+ /**
653
+ * Get a learner\'s effective attempt limit for a course item
654
+ */
655
+ getCourseItemLearnerAttemptAllowanceRaw(requestParameters, initOverrides) {
656
+ return __awaiter(this, void 0, void 0, function* () {
657
+ const requestOptions = yield this.getCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters);
658
+ const response = yield this.request(requestOptions, initOverrides);
659
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetAttemptAllowance_1.GetAttemptAllowanceFromJSON)(jsonValue));
660
+ });
661
+ }
662
+ /**
663
+ * Get a learner\'s effective attempt limit for a course item
664
+ */
665
+ getCourseItemLearnerAttemptAllowance(requestParameters, initOverrides) {
666
+ return __awaiter(this, void 0, void 0, function* () {
667
+ const response = yield this.getCourseItemLearnerAttemptAllowanceRaw(requestParameters, initOverrides);
668
+ return yield response.value();
669
+ });
670
+ }
616
671
  /**
617
672
  * Creates request options for getCourseList without sending the request
618
673
  */
@@ -1106,6 +1161,62 @@ class CourseApi extends runtime.BaseAPI {
1106
1161
  return yield response.value();
1107
1162
  });
1108
1163
  }
1164
+ /**
1165
+ * Creates request options for postCourseItemLearnerSessionsClear without sending the request
1166
+ */
1167
+ postCourseItemLearnerSessionsClearRequestOpts(requestParameters) {
1168
+ return __awaiter(this, void 0, void 0, function* () {
1169
+ if (requestParameters['courseId'] == null) {
1170
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling postCourseItemLearnerSessionsClear().');
1171
+ }
1172
+ if (requestParameters['courseVersionId'] == null) {
1173
+ throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling postCourseItemLearnerSessionsClear().');
1174
+ }
1175
+ if (requestParameters['itemId'] == null) {
1176
+ throw new runtime.RequiredError('itemId', 'Required parameter "itemId" was null or undefined when calling postCourseItemLearnerSessionsClear().');
1177
+ }
1178
+ if (requestParameters['userId'] == null) {
1179
+ throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling postCourseItemLearnerSessionsClear().');
1180
+ }
1181
+ if (requestParameters['postClearSessions'] == null) {
1182
+ throw new runtime.RequiredError('postClearSessions', 'Required parameter "postClearSessions" was null or undefined when calling postCourseItemLearnerSessionsClear().');
1183
+ }
1184
+ const queryParameters = {};
1185
+ const headerParameters = {};
1186
+ headerParameters['Content-Type'] = 'application/json';
1187
+ let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/sessions/clear`;
1188
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
1189
+ urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
1190
+ urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
1191
+ urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
1192
+ return {
1193
+ path: urlPath,
1194
+ method: 'POST',
1195
+ headers: headerParameters,
1196
+ query: queryParameters,
1197
+ body: (0, PostClearSessions_1.PostClearSessionsToJSON)(requestParameters['postClearSessions']),
1198
+ };
1199
+ });
1200
+ }
1201
+ /**
1202
+ * Clear all live sessions for a learner and course item
1203
+ */
1204
+ postCourseItemLearnerSessionsClearRaw(requestParameters, initOverrides) {
1205
+ return __awaiter(this, void 0, void 0, function* () {
1206
+ const requestOptions = yield this.postCourseItemLearnerSessionsClearRequestOpts(requestParameters);
1207
+ const response = yield this.request(requestOptions, initOverrides);
1208
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, PostClearSessionsResponse_1.PostClearSessionsResponseFromJSON)(jsonValue));
1209
+ });
1210
+ }
1211
+ /**
1212
+ * Clear all live sessions for a learner and course item
1213
+ */
1214
+ postCourseItemLearnerSessionsClear(requestParameters, initOverrides) {
1215
+ return __awaiter(this, void 0, void 0, function* () {
1216
+ const response = yield this.postCourseItemLearnerSessionsClearRaw(requestParameters, initOverrides);
1217
+ return yield response.value();
1218
+ });
1219
+ }
1109
1220
  /**
1110
1221
  * Creates request options for postCourseResume without sending the request
1111
1222
  */
@@ -1477,6 +1588,62 @@ class CourseApi extends runtime.BaseAPI {
1477
1588
  return yield response.value();
1478
1589
  });
1479
1590
  }
1591
+ /**
1592
+ * Creates request options for putCourseItemLearnerAttemptAllowance without sending the request
1593
+ */
1594
+ putCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters) {
1595
+ return __awaiter(this, void 0, void 0, function* () {
1596
+ if (requestParameters['courseId'] == null) {
1597
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().');
1598
+ }
1599
+ if (requestParameters['courseVersionId'] == null) {
1600
+ throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().');
1601
+ }
1602
+ if (requestParameters['itemId'] == null) {
1603
+ throw new runtime.RequiredError('itemId', 'Required parameter "itemId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().');
1604
+ }
1605
+ if (requestParameters['userId'] == null) {
1606
+ throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().');
1607
+ }
1608
+ if (requestParameters['putAttemptAllowance'] == null) {
1609
+ throw new runtime.RequiredError('putAttemptAllowance', 'Required parameter "putAttemptAllowance" was null or undefined when calling putCourseItemLearnerAttemptAllowance().');
1610
+ }
1611
+ const queryParameters = {};
1612
+ const headerParameters = {};
1613
+ headerParameters['Content-Type'] = 'application/json';
1614
+ let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance`;
1615
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
1616
+ urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
1617
+ urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
1618
+ urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
1619
+ return {
1620
+ path: urlPath,
1621
+ method: 'PUT',
1622
+ headers: headerParameters,
1623
+ query: queryParameters,
1624
+ body: (0, PutAttemptAllowance_1.PutAttemptAllowanceToJSON)(requestParameters['putAttemptAllowance']),
1625
+ };
1626
+ });
1627
+ }
1628
+ /**
1629
+ * Set extra attempts for a learner on a course item
1630
+ */
1631
+ putCourseItemLearnerAttemptAllowanceRaw(requestParameters, initOverrides) {
1632
+ return __awaiter(this, void 0, void 0, function* () {
1633
+ const requestOptions = yield this.putCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters);
1634
+ const response = yield this.request(requestOptions, initOverrides);
1635
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetAttemptAllowance_1.GetAttemptAllowanceFromJSON)(jsonValue));
1636
+ });
1637
+ }
1638
+ /**
1639
+ * Set extra attempts for a learner on a course item
1640
+ */
1641
+ putCourseItemLearnerAttemptAllowance(requestParameters, initOverrides) {
1642
+ return __awaiter(this, void 0, void 0, function* () {
1643
+ const response = yield this.putCourseItemLearnerAttemptAllowanceRaw(requestParameters, initOverrides);
1644
+ return yield response.value();
1645
+ });
1646
+ }
1480
1647
  /**
1481
1648
  * Creates request options for putCourseVersionItem without sending the request
1482
1649
  */
@@ -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
  */
@@ -25,10 +25,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
25
25
  exports.GetResourceSessionScormApiLogsMethodEnum = exports.GetResourceSessionListSortDirectionEnum = exports.GetResourceSessionListSortByEnum = exports.GetResourceSessionListGradeStatusEnum = exports.GetResourceSessionListCompletionStatusEnum = exports.PlayerApi = void 0;
26
26
  const runtime = require("../runtime");
27
27
  const GetResourceSession_1 = require("../models/GetResourceSession");
28
+ const GetResourceSessionActivity_1 = require("../models/GetResourceSessionActivity");
29
+ const GetResourceSessionActivityEventList_1 = require("../models/GetResourceSessionActivityEventList");
30
+ const GetResourceSessionActivityList_1 = require("../models/GetResourceSessionActivityList");
28
31
  const GetResourceSessionDiagnostics_1 = require("../models/GetResourceSessionDiagnostics");
29
32
  const GetResourceSessionList_1 = require("../models/GetResourceSessionList");
30
33
  const GetResourceSessionScormApiLogs_1 = require("../models/GetResourceSessionScormApiLogs");
31
34
  const GetResourceSessionScormData_1 = require("../models/GetResourceSessionScormData");
35
+ const PostResourceSessionActivityEvent_1 = require("../models/PostResourceSessionActivityEvent");
36
+ const PutResourceSessionOverride_1 = require("../models/PutResourceSessionOverride");
32
37
  const ScormGetValueResponse_1 = require("../models/ScormGetValueResponse");
33
38
  const ScormSetValueRequest_1 = require("../models/ScormSetValueRequest");
34
39
  const ScormSetValueResponse_1 = require("../models/ScormSetValueResponse");
@@ -45,6 +50,9 @@ class PlayerApi extends runtime.BaseAPI {
45
50
  throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling commitResourceScormSession().');
46
51
  }
47
52
  const queryParameters = {};
53
+ if (requestParameters['activityId'] != null) {
54
+ queryParameters['activity_id'] = requestParameters['activityId'];
55
+ }
48
56
  const headerParameters = {};
49
57
  let urlPath = `/resource/sessions/{sessionId}/commit`;
50
58
  urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
@@ -180,6 +188,9 @@ class PlayerApi extends runtime.BaseAPI {
180
188
  if (requestParameters['key'] != null) {
181
189
  queryParameters['key'] = requestParameters['key'];
182
190
  }
191
+ if (requestParameters['activityId'] != null) {
192
+ queryParameters['activity_id'] = requestParameters['activityId'];
193
+ }
183
194
  const headerParameters = {};
184
195
  let urlPath = `/resource/sessions/{sessionId}/get-value`;
185
196
  urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
@@ -249,6 +260,84 @@ class PlayerApi extends runtime.BaseAPI {
249
260
  return yield response.value();
250
261
  });
251
262
  }
263
+ /**
264
+ * Creates request options for getResourceSessionActivities without sending the request
265
+ */
266
+ getResourceSessionActivitiesRequestOpts(requestParameters) {
267
+ return __awaiter(this, void 0, void 0, function* () {
268
+ if (requestParameters['sessionId'] == null) {
269
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionActivities().');
270
+ }
271
+ const queryParameters = {};
272
+ const headerParameters = {};
273
+ let urlPath = `/resource/sessions/{sessionId}/activities`;
274
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
275
+ return {
276
+ path: urlPath,
277
+ method: 'GET',
278
+ headers: headerParameters,
279
+ query: queryParameters,
280
+ };
281
+ });
282
+ }
283
+ /**
284
+ * List tracked activities for a resource session
285
+ */
286
+ getResourceSessionActivitiesRaw(requestParameters, initOverrides) {
287
+ return __awaiter(this, void 0, void 0, function* () {
288
+ const requestOptions = yield this.getResourceSessionActivitiesRequestOpts(requestParameters);
289
+ const response = yield this.request(requestOptions, initOverrides);
290
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSessionActivityList_1.GetResourceSessionActivityListFromJSON)(jsonValue));
291
+ });
292
+ }
293
+ /**
294
+ * List tracked activities for a resource session
295
+ */
296
+ getResourceSessionActivities(requestParameters, initOverrides) {
297
+ return __awaiter(this, void 0, void 0, function* () {
298
+ const response = yield this.getResourceSessionActivitiesRaw(requestParameters, initOverrides);
299
+ return yield response.value();
300
+ });
301
+ }
302
+ /**
303
+ * Creates request options for getResourceSessionActivityEvents without sending the request
304
+ */
305
+ getResourceSessionActivityEventsRequestOpts(requestParameters) {
306
+ return __awaiter(this, void 0, void 0, function* () {
307
+ if (requestParameters['sessionId'] == null) {
308
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionActivityEvents().');
309
+ }
310
+ const queryParameters = {};
311
+ const headerParameters = {};
312
+ let urlPath = `/resource/sessions/{sessionId}/activity-events`;
313
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
314
+ return {
315
+ path: urlPath,
316
+ method: 'GET',
317
+ headers: headerParameters,
318
+ query: queryParameters,
319
+ };
320
+ });
321
+ }
322
+ /**
323
+ * List recorded learner activity events for a resource session
324
+ */
325
+ getResourceSessionActivityEventsRaw(requestParameters, initOverrides) {
326
+ return __awaiter(this, void 0, void 0, function* () {
327
+ const requestOptions = yield this.getResourceSessionActivityEventsRequestOpts(requestParameters);
328
+ const response = yield this.request(requestOptions, initOverrides);
329
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSessionActivityEventList_1.GetResourceSessionActivityEventListFromJSON)(jsonValue));
330
+ });
331
+ }
332
+ /**
333
+ * List recorded learner activity events for a resource session
334
+ */
335
+ getResourceSessionActivityEvents(requestParameters, initOverrides) {
336
+ return __awaiter(this, void 0, void 0, function* () {
337
+ const response = yield this.getResourceSessionActivityEventsRaw(requestParameters, initOverrides);
338
+ return yield response.value();
339
+ });
340
+ }
252
341
  /**
253
342
  * Creates request options for getResourceSessionAsset without sending the request
254
343
  */
@@ -536,6 +625,9 @@ class PlayerApi extends runtime.BaseAPI {
536
625
  throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionScormData().');
537
626
  }
538
627
  const queryParameters = {};
628
+ if (requestParameters['activityId'] != null) {
629
+ queryParameters['activity_id'] = requestParameters['activityId'];
630
+ }
539
631
  const headerParameters = {};
540
632
  let urlPath = `/resource/sessions/{sessionId}/scorm-data`;
541
633
  urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
@@ -575,6 +667,9 @@ class PlayerApi extends runtime.BaseAPI {
575
667
  throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling initializeResourceScormSession().');
576
668
  }
577
669
  const queryParameters = {};
670
+ if (requestParameters['activityId'] != null) {
671
+ queryParameters['activity_id'] = requestParameters['activityId'];
672
+ }
578
673
  const headerParameters = {};
579
674
  let urlPath = `/resource/sessions/{sessionId}/initialize`;
580
675
  urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
@@ -604,6 +699,54 @@ class PlayerApi extends runtime.BaseAPI {
604
699
  yield this.initializeResourceScormSessionRaw(requestParameters, initOverrides);
605
700
  });
606
701
  }
702
+ /**
703
+ * Creates request options for postResourceSessionActivityEvent without sending the request
704
+ */
705
+ postResourceSessionActivityEventRequestOpts(requestParameters) {
706
+ return __awaiter(this, void 0, void 0, function* () {
707
+ if (requestParameters['sessionId'] == null) {
708
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling postResourceSessionActivityEvent().');
709
+ }
710
+ if (requestParameters['activityId'] == null) {
711
+ throw new runtime.RequiredError('activityId', 'Required parameter "activityId" was null or undefined when calling postResourceSessionActivityEvent().');
712
+ }
713
+ if (requestParameters['postResourceSessionActivityEvent'] == null) {
714
+ throw new runtime.RequiredError('postResourceSessionActivityEvent', 'Required parameter "postResourceSessionActivityEvent" was null or undefined when calling postResourceSessionActivityEvent().');
715
+ }
716
+ const queryParameters = {};
717
+ const headerParameters = {};
718
+ headerParameters['Content-Type'] = 'application/json';
719
+ let urlPath = `/resource/sessions/{sessionId}/activities/{activityId}/events`;
720
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
721
+ urlPath = urlPath.replace('{activityId}', encodeURIComponent(String(requestParameters['activityId'])));
722
+ return {
723
+ path: urlPath,
724
+ method: 'POST',
725
+ headers: headerParameters,
726
+ query: queryParameters,
727
+ body: (0, PostResourceSessionActivityEvent_1.PostResourceSessionActivityEventToJSON)(requestParameters['postResourceSessionActivityEvent']),
728
+ };
729
+ });
730
+ }
731
+ /**
732
+ * Record learner activity and update active time
733
+ */
734
+ postResourceSessionActivityEventRaw(requestParameters, initOverrides) {
735
+ return __awaiter(this, void 0, void 0, function* () {
736
+ const requestOptions = yield this.postResourceSessionActivityEventRequestOpts(requestParameters);
737
+ const response = yield this.request(requestOptions, initOverrides);
738
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSessionActivity_1.GetResourceSessionActivityFromJSON)(jsonValue));
739
+ });
740
+ }
741
+ /**
742
+ * Record learner activity and update active time
743
+ */
744
+ postResourceSessionActivityEvent(requestParameters, initOverrides) {
745
+ return __awaiter(this, void 0, void 0, function* () {
746
+ const response = yield this.postResourceSessionActivityEventRaw(requestParameters, initOverrides);
747
+ return yield response.value();
748
+ });
749
+ }
607
750
  /**
608
751
  * Creates request options for postResourceSessionComplete without sending the request
609
752
  */
@@ -643,6 +786,50 @@ class PlayerApi extends runtime.BaseAPI {
643
786
  return yield response.value();
644
787
  });
645
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
+ }
646
833
  /**
647
834
  * Creates request options for setResourceScormValue without sending the request
648
835
  */
@@ -655,6 +842,9 @@ class PlayerApi extends runtime.BaseAPI {
655
842
  throw new runtime.RequiredError('scormSetValueRequest', 'Required parameter "scormSetValueRequest" was null or undefined when calling setResourceScormValue().');
656
843
  }
657
844
  const queryParameters = {};
845
+ if (requestParameters['activityId'] != null) {
846
+ queryParameters['activity_id'] = requestParameters['activityId'];
847
+ }
658
848
  const headerParameters = {};
659
849
  headerParameters['Content-Type'] = 'application/json';
660
850
  let urlPath = `/resource/sessions/{sessionId}/set-value`;
@@ -696,6 +886,9 @@ class PlayerApi extends runtime.BaseAPI {
696
886
  throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling terminateResourceScormSession().');
697
887
  }
698
888
  const queryParameters = {};
889
+ if (requestParameters['activityId'] != null) {
890
+ queryParameters['activity_id'] = requestParameters['activityId'];
891
+ }
699
892
  const headerParameters = {};
700
893
  let urlPath = `/resource/sessions/{sessionId}/terminate`;
701
894
  urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
@@ -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
  */