@easyedu/js-lsm-api 1.98.0 → 1.99.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.
- package/.openapi-generator/FILES +10 -0
- package/README.md +10 -2
- package/dist/apis/PlayerApi.d.ts +57 -0
- package/dist/apis/PlayerApi.js +148 -0
- package/dist/esm/apis/PlayerApi.d.ts +57 -0
- package/dist/esm/apis/PlayerApi.js +148 -0
- package/dist/esm/models/GetCourseVersionItemSession.d.ts +6 -0
- package/dist/esm/models/GetCourseVersionItemSession.js +4 -0
- package/dist/esm/models/GetLibraryQuizSession.d.ts +6 -0
- package/dist/esm/models/GetLibraryQuizSession.js +4 -0
- package/dist/esm/models/GetResourceSession.d.ts +6 -0
- package/dist/esm/models/GetResourceSession.js +4 -0
- package/dist/esm/models/GetResourceSessionActivity.d.ts +125 -0
- package/dist/esm/models/GetResourceSessionActivity.js +97 -0
- package/dist/esm/models/GetResourceSessionActivityEvent.d.ts +62 -0
- package/dist/esm/models/GetResourceSessionActivityEvent.js +61 -0
- package/dist/esm/models/GetResourceSessionActivityEventList.d.ts +33 -0
- package/dist/esm/models/GetResourceSessionActivityEventList.js +44 -0
- package/dist/esm/models/GetResourceSessionActivityList.d.ts +33 -0
- package/dist/esm/models/GetResourceSessionActivityList.js +44 -0
- package/dist/esm/models/PostResourceSessionActivityEvent.d.ts +62 -0
- package/dist/esm/models/PostResourceSessionActivityEvent.js +66 -0
- package/dist/esm/models/index.d.ts +5 -0
- package/dist/esm/models/index.js +5 -0
- package/dist/models/GetCourseVersionItemSession.d.ts +6 -0
- package/dist/models/GetCourseVersionItemSession.js +4 -0
- package/dist/models/GetLibraryQuizSession.d.ts +6 -0
- package/dist/models/GetLibraryQuizSession.js +4 -0
- package/dist/models/GetResourceSession.d.ts +6 -0
- package/dist/models/GetResourceSession.js +4 -0
- package/dist/models/GetResourceSessionActivity.d.ts +125 -0
- package/dist/models/GetResourceSessionActivity.js +105 -0
- package/dist/models/GetResourceSessionActivityEvent.d.ts +62 -0
- package/dist/models/GetResourceSessionActivityEvent.js +68 -0
- package/dist/models/GetResourceSessionActivityEventList.d.ts +33 -0
- package/dist/models/GetResourceSessionActivityEventList.js +51 -0
- package/dist/models/GetResourceSessionActivityList.d.ts +33 -0
- package/dist/models/GetResourceSessionActivityList.js +51 -0
- package/dist/models/PostResourceSessionActivityEvent.d.ts +62 -0
- package/dist/models/PostResourceSessionActivityEvent.js +74 -0
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/docs/ContentLibraryQuizApi.md +2 -2
- package/docs/GetCourseVersionItemSession.md +2 -0
- package/docs/GetLibraryQuizSession.md +2 -0
- package/docs/GetResourceSession.md +2 -0
- package/docs/GetResourceSessionActivity.md +63 -0
- package/docs/GetResourceSessionActivityEvent.md +45 -0
- package/docs/GetResourceSessionActivityEventList.md +35 -0
- package/docs/GetResourceSessionActivityList.md +35 -0
- package/docs/PlayerApi.md +231 -6
- package/docs/PostResourceSessionActivityEvent.md +39 -0
- package/package.json +1 -1
- package/src/apis/PlayerApi.ts +217 -0
- package/src/models/GetCourseVersionItemSession.ts +9 -0
- package/src/models/GetLibraryQuizSession.ts +9 -0
- package/src/models/GetResourceSession.ts +9 -0
- package/src/models/GetResourceSessionActivity.ts +199 -0
- package/src/models/GetResourceSessionActivityEvent.ts +110 -0
- package/src/models/GetResourceSessionActivityEventList.ts +74 -0
- package/src/models/GetResourceSessionActivityList.ts +74 -0
- package/src/models/PostResourceSessionActivityEvent.ts +104 -0
- package/src/models/index.ts +5 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -103,6 +103,10 @@ docs/GetQuestionQuizzesInner.md
|
|
|
103
103
|
docs/GetResource.md
|
|
104
104
|
docs/GetResourceList.md
|
|
105
105
|
docs/GetResourceSession.md
|
|
106
|
+
docs/GetResourceSessionActivity.md
|
|
107
|
+
docs/GetResourceSessionActivityEvent.md
|
|
108
|
+
docs/GetResourceSessionActivityEventList.md
|
|
109
|
+
docs/GetResourceSessionActivityList.md
|
|
106
110
|
docs/GetResourceSessionDiagnostics.md
|
|
107
111
|
docs/GetResourceSessionDiagnosticsCourseContext.md
|
|
108
112
|
docs/GetResourceSessionDiagnosticsResource.md
|
|
@@ -202,6 +206,7 @@ docs/PostQuestion.md
|
|
|
202
206
|
docs/PostQuestionAnswerChoicesInner.md
|
|
203
207
|
docs/PostResetPassword.md
|
|
204
208
|
docs/PostResource.md
|
|
209
|
+
docs/PostResourceSessionActivityEvent.md
|
|
205
210
|
docs/PostResourceVersion.md
|
|
206
211
|
docs/PostResourceVersionComplete.md
|
|
207
212
|
docs/PostResourceVersionSession.md
|
|
@@ -379,6 +384,10 @@ src/models/GetQuestionQuizzesInner.ts
|
|
|
379
384
|
src/models/GetResource.ts
|
|
380
385
|
src/models/GetResourceList.ts
|
|
381
386
|
src/models/GetResourceSession.ts
|
|
387
|
+
src/models/GetResourceSessionActivity.ts
|
|
388
|
+
src/models/GetResourceSessionActivityEvent.ts
|
|
389
|
+
src/models/GetResourceSessionActivityEventList.ts
|
|
390
|
+
src/models/GetResourceSessionActivityList.ts
|
|
382
391
|
src/models/GetResourceSessionDiagnostics.ts
|
|
383
392
|
src/models/GetResourceSessionDiagnosticsCourseContext.ts
|
|
384
393
|
src/models/GetResourceSessionDiagnosticsResource.ts
|
|
@@ -474,6 +483,7 @@ src/models/PostQuestion.ts
|
|
|
474
483
|
src/models/PostQuestionAnswerChoicesInner.ts
|
|
475
484
|
src/models/PostResetPassword.ts
|
|
476
485
|
src/models/PostResource.ts
|
|
486
|
+
src/models/PostResourceSessionActivityEvent.ts
|
|
477
487
|
src/models/PostResourceVersion.ts
|
|
478
488
|
src/models/PostResourceVersionComplete.ts
|
|
479
489
|
src/models/PostResourceVersionSession.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
1
|
+
# @easyedu/js-lsm-api@1.99.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
|
|
4
4
|
|
|
@@ -255,6 +255,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
255
255
|
*PlayerApi* | [**getLibraryQuizSessionPlayer**](docs/PlayerApi.md#getlibraryquizsessionplayer) | **GET** /quiz/sessions/{sessionId}/player | Serve the player for a reusable quiz session
|
|
256
256
|
*PlayerApi* | [**getResourceScormValue**](docs/PlayerApi.md#getresourcescormvalue) | **GET** /resource/sessions/{sessionId}/get-value | Read a CMI value from a reusable SCORM resource session
|
|
257
257
|
*PlayerApi* | [**getResourceSession**](docs/PlayerApi.md#getresourcesession) | **GET** /resource/sessions/{sessionId} | Get a resource session
|
|
258
|
+
*PlayerApi* | [**getResourceSessionActivities**](docs/PlayerApi.md#getresourcesessionactivities) | **GET** /resource/sessions/{sessionId}/activities | List tracked activities for a resource session
|
|
259
|
+
*PlayerApi* | [**getResourceSessionActivityEvents**](docs/PlayerApi.md#getresourcesessionactivityevents) | **GET** /resource/sessions/{sessionId}/activity-events | List recorded learner activity events for a resource session
|
|
258
260
|
*PlayerApi* | [**getResourceSessionAsset**](docs/PlayerApi.md#getresourcesessionasset) | **GET** /resource/sessions/{sessionId}/asset/{assetPath} | Stream an asset pinned to a resource session
|
|
259
261
|
*PlayerApi* | [**getResourceSessionDiagnostics**](docs/PlayerApi.md#getresourcesessiondiagnostics) | **GET** /resource/sessions/{sessionId}/diagnostics | Get administrator diagnostics for a resource session
|
|
260
262
|
*PlayerApi* | [**getResourceSessionList**](docs/PlayerApi.md#getresourcesessionlist) | **GET** /resource/sessions | List resource sessions for the selected portal
|
|
@@ -262,6 +264,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
262
264
|
*PlayerApi* | [**getResourceSessionScormApiLogs**](docs/PlayerApi.md#getresourcesessionscormapilogs) | **GET** /resource/sessions/{sessionId}/api-logs | Get SCORM runtime logs for a resource session
|
|
263
265
|
*PlayerApi* | [**getResourceSessionScormData**](docs/PlayerApi.md#getresourcesessionscormdata) | **GET** /resource/sessions/{sessionId}/scorm-data | Get SCORM CMI data for a resource session
|
|
264
266
|
*PlayerApi* | [**initializeResourceScormSession**](docs/PlayerApi.md#initializeresourcescormsession) | **POST** /resource/sessions/{sessionId}/initialize | Initialize a reusable SCORM resource session
|
|
267
|
+
*PlayerApi* | [**postResourceSessionActivityEvent**](docs/PlayerApi.md#postresourcesessionactivityevent) | **POST** /resource/sessions/{sessionId}/activities/{activityId}/events | Record learner activity and update active time
|
|
265
268
|
*PlayerApi* | [**postResourceSessionComplete**](docs/PlayerApi.md#postresourcesessioncomplete) | **POST** /resource/sessions/{sessionId}/complete | Complete a non-SCORM resource session
|
|
266
269
|
*PlayerApi* | [**setResourceScormValue**](docs/PlayerApi.md#setresourcescormvalue) | **POST** /resource/sessions/{sessionId}/set-value | Store a CMI value in a reusable SCORM resource session
|
|
267
270
|
*PlayerApi* | [**terminateResourceScormSession**](docs/PlayerApi.md#terminateresourcescormsession) | **POST** /resource/sessions/{sessionId}/terminate | Terminate a reusable SCORM resource session
|
|
@@ -431,6 +434,10 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
431
434
|
- [GetResource](docs/GetResource.md)
|
|
432
435
|
- [GetResourceList](docs/GetResourceList.md)
|
|
433
436
|
- [GetResourceSession](docs/GetResourceSession.md)
|
|
437
|
+
- [GetResourceSessionActivity](docs/GetResourceSessionActivity.md)
|
|
438
|
+
- [GetResourceSessionActivityEvent](docs/GetResourceSessionActivityEvent.md)
|
|
439
|
+
- [GetResourceSessionActivityEventList](docs/GetResourceSessionActivityEventList.md)
|
|
440
|
+
- [GetResourceSessionActivityList](docs/GetResourceSessionActivityList.md)
|
|
434
441
|
- [GetResourceSessionDiagnostics](docs/GetResourceSessionDiagnostics.md)
|
|
435
442
|
- [GetResourceSessionDiagnosticsCourseContext](docs/GetResourceSessionDiagnosticsCourseContext.md)
|
|
436
443
|
- [GetResourceSessionDiagnosticsResource](docs/GetResourceSessionDiagnosticsResource.md)
|
|
@@ -526,6 +533,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
526
533
|
- [PostQuestionAnswerChoicesInner](docs/PostQuestionAnswerChoicesInner.md)
|
|
527
534
|
- [PostResetPassword](docs/PostResetPassword.md)
|
|
528
535
|
- [PostResource](docs/PostResource.md)
|
|
536
|
+
- [PostResourceSessionActivityEvent](docs/PostResourceSessionActivityEvent.md)
|
|
529
537
|
- [PostResourceVersion](docs/PostResourceVersion.md)
|
|
530
538
|
- [PostResourceVersionComplete](docs/PostResourceVersionComplete.md)
|
|
531
539
|
- [PostResourceVersionSession](docs/PostResourceVersionSession.md)
|
|
@@ -594,7 +602,7 @@ and is automatically generated by the
|
|
|
594
602
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
595
603
|
|
|
596
604
|
- API version: `1.0.0`
|
|
597
|
-
- Package version: `1.
|
|
605
|
+
- Package version: `1.99.0`
|
|
598
606
|
- Generator version: `7.22.0`
|
|
599
607
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
600
608
|
|
package/dist/apis/PlayerApi.d.ts
CHANGED
|
@@ -11,10 +11,14 @@
|
|
|
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';
|
|
18
22
|
import { type ResourceSessionEnvironment } from '../models/ResourceSessionEnvironment';
|
|
19
23
|
import { type ResourceType } from '../models/ResourceType';
|
|
20
24
|
import { type ScormGetValueResponse } from '../models/ScormGetValueResponse';
|
|
@@ -22,6 +26,7 @@ import { type ScormSetValueRequest } from '../models/ScormSetValueRequest';
|
|
|
22
26
|
import { type ScormSetValueResponse } from '../models/ScormSetValueResponse';
|
|
23
27
|
export interface CommitResourceScormSessionRequest {
|
|
24
28
|
sessionId: string;
|
|
29
|
+
activityId?: string;
|
|
25
30
|
}
|
|
26
31
|
export interface GetCourseVersionResourceAssetRequest {
|
|
27
32
|
courseVersionId: string;
|
|
@@ -34,10 +39,17 @@ export interface GetLibraryQuizSessionPlayerRequest {
|
|
|
34
39
|
export interface GetResourceScormValueRequest {
|
|
35
40
|
sessionId: string;
|
|
36
41
|
key: string;
|
|
42
|
+
activityId?: string;
|
|
37
43
|
}
|
|
38
44
|
export interface GetResourceSessionRequest {
|
|
39
45
|
sessionId: string;
|
|
40
46
|
}
|
|
47
|
+
export interface GetResourceSessionActivitiesRequest {
|
|
48
|
+
sessionId: string;
|
|
49
|
+
}
|
|
50
|
+
export interface GetResourceSessionActivityEventsRequest {
|
|
51
|
+
sessionId: string;
|
|
52
|
+
}
|
|
41
53
|
export interface GetResourceSessionAssetRequest {
|
|
42
54
|
sessionId: string;
|
|
43
55
|
assetPath: string;
|
|
@@ -81,9 +93,16 @@ export interface GetResourceSessionScormApiLogsRequest {
|
|
|
81
93
|
}
|
|
82
94
|
export interface GetResourceSessionScormDataRequest {
|
|
83
95
|
sessionId: string;
|
|
96
|
+
activityId?: string;
|
|
84
97
|
}
|
|
85
98
|
export interface InitializeResourceScormSessionRequest {
|
|
86
99
|
sessionId: string;
|
|
100
|
+
activityId?: string;
|
|
101
|
+
}
|
|
102
|
+
export interface PostResourceSessionActivityEventRequest {
|
|
103
|
+
sessionId: string;
|
|
104
|
+
activityId: string;
|
|
105
|
+
postResourceSessionActivityEvent: PostResourceSessionActivityEvent;
|
|
87
106
|
}
|
|
88
107
|
export interface PostResourceSessionCompleteRequest {
|
|
89
108
|
sessionId: string;
|
|
@@ -91,9 +110,11 @@ export interface PostResourceSessionCompleteRequest {
|
|
|
91
110
|
export interface SetResourceScormValueRequest {
|
|
92
111
|
sessionId: string;
|
|
93
112
|
scormSetValueRequest: ScormSetValueRequest;
|
|
113
|
+
activityId?: string;
|
|
94
114
|
}
|
|
95
115
|
export interface TerminateResourceScormSessionRequest {
|
|
96
116
|
sessionId: string;
|
|
117
|
+
activityId?: string;
|
|
97
118
|
}
|
|
98
119
|
/**
|
|
99
120
|
*
|
|
@@ -159,6 +180,30 @@ export declare class PlayerApi extends runtime.BaseAPI {
|
|
|
159
180
|
* Get a resource session
|
|
160
181
|
*/
|
|
161
182
|
getResourceSession(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
|
|
183
|
+
/**
|
|
184
|
+
* Creates request options for getResourceSessionActivities without sending the request
|
|
185
|
+
*/
|
|
186
|
+
getResourceSessionActivitiesRequestOpts(requestParameters: GetResourceSessionActivitiesRequest): Promise<runtime.RequestOpts>;
|
|
187
|
+
/**
|
|
188
|
+
* List tracked activities for a resource session
|
|
189
|
+
*/
|
|
190
|
+
getResourceSessionActivitiesRaw(requestParameters: GetResourceSessionActivitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionActivityList>>;
|
|
191
|
+
/**
|
|
192
|
+
* List tracked activities for a resource session
|
|
193
|
+
*/
|
|
194
|
+
getResourceSessionActivities(requestParameters: GetResourceSessionActivitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionActivityList>;
|
|
195
|
+
/**
|
|
196
|
+
* Creates request options for getResourceSessionActivityEvents without sending the request
|
|
197
|
+
*/
|
|
198
|
+
getResourceSessionActivityEventsRequestOpts(requestParameters: GetResourceSessionActivityEventsRequest): Promise<runtime.RequestOpts>;
|
|
199
|
+
/**
|
|
200
|
+
* List recorded learner activity events for a resource session
|
|
201
|
+
*/
|
|
202
|
+
getResourceSessionActivityEventsRaw(requestParameters: GetResourceSessionActivityEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionActivityEventList>>;
|
|
203
|
+
/**
|
|
204
|
+
* List recorded learner activity events for a resource session
|
|
205
|
+
*/
|
|
206
|
+
getResourceSessionActivityEvents(requestParameters: GetResourceSessionActivityEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionActivityEventList>;
|
|
162
207
|
/**
|
|
163
208
|
* Creates request options for getResourceSessionAsset without sending the request
|
|
164
209
|
*/
|
|
@@ -243,6 +288,18 @@ export declare class PlayerApi extends runtime.BaseAPI {
|
|
|
243
288
|
* Initialize a reusable SCORM resource session
|
|
244
289
|
*/
|
|
245
290
|
initializeResourceScormSession(requestParameters: InitializeResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
291
|
+
/**
|
|
292
|
+
* Creates request options for postResourceSessionActivityEvent without sending the request
|
|
293
|
+
*/
|
|
294
|
+
postResourceSessionActivityEventRequestOpts(requestParameters: PostResourceSessionActivityEventRequest): Promise<runtime.RequestOpts>;
|
|
295
|
+
/**
|
|
296
|
+
* Record learner activity and update active time
|
|
297
|
+
*/
|
|
298
|
+
postResourceSessionActivityEventRaw(requestParameters: PostResourceSessionActivityEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionActivity>>;
|
|
299
|
+
/**
|
|
300
|
+
* Record learner activity and update active time
|
|
301
|
+
*/
|
|
302
|
+
postResourceSessionActivityEvent(requestParameters: PostResourceSessionActivityEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionActivity>;
|
|
246
303
|
/**
|
|
247
304
|
* Creates request options for postResourceSessionComplete without sending the request
|
|
248
305
|
*/
|
package/dist/apis/PlayerApi.js
CHANGED
|
@@ -25,10 +25,14 @@ 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");
|
|
32
36
|
const ScormGetValueResponse_1 = require("../models/ScormGetValueResponse");
|
|
33
37
|
const ScormSetValueRequest_1 = require("../models/ScormSetValueRequest");
|
|
34
38
|
const ScormSetValueResponse_1 = require("../models/ScormSetValueResponse");
|
|
@@ -45,6 +49,9 @@ class PlayerApi extends runtime.BaseAPI {
|
|
|
45
49
|
throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling commitResourceScormSession().');
|
|
46
50
|
}
|
|
47
51
|
const queryParameters = {};
|
|
52
|
+
if (requestParameters['activityId'] != null) {
|
|
53
|
+
queryParameters['activity_id'] = requestParameters['activityId'];
|
|
54
|
+
}
|
|
48
55
|
const headerParameters = {};
|
|
49
56
|
let urlPath = `/resource/sessions/{sessionId}/commit`;
|
|
50
57
|
urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
|
|
@@ -180,6 +187,9 @@ class PlayerApi extends runtime.BaseAPI {
|
|
|
180
187
|
if (requestParameters['key'] != null) {
|
|
181
188
|
queryParameters['key'] = requestParameters['key'];
|
|
182
189
|
}
|
|
190
|
+
if (requestParameters['activityId'] != null) {
|
|
191
|
+
queryParameters['activity_id'] = requestParameters['activityId'];
|
|
192
|
+
}
|
|
183
193
|
const headerParameters = {};
|
|
184
194
|
let urlPath = `/resource/sessions/{sessionId}/get-value`;
|
|
185
195
|
urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
|
|
@@ -249,6 +259,84 @@ class PlayerApi extends runtime.BaseAPI {
|
|
|
249
259
|
return yield response.value();
|
|
250
260
|
});
|
|
251
261
|
}
|
|
262
|
+
/**
|
|
263
|
+
* Creates request options for getResourceSessionActivities without sending the request
|
|
264
|
+
*/
|
|
265
|
+
getResourceSessionActivitiesRequestOpts(requestParameters) {
|
|
266
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
267
|
+
if (requestParameters['sessionId'] == null) {
|
|
268
|
+
throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionActivities().');
|
|
269
|
+
}
|
|
270
|
+
const queryParameters = {};
|
|
271
|
+
const headerParameters = {};
|
|
272
|
+
let urlPath = `/resource/sessions/{sessionId}/activities`;
|
|
273
|
+
urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
|
|
274
|
+
return {
|
|
275
|
+
path: urlPath,
|
|
276
|
+
method: 'GET',
|
|
277
|
+
headers: headerParameters,
|
|
278
|
+
query: queryParameters,
|
|
279
|
+
};
|
|
280
|
+
});
|
|
281
|
+
}
|
|
282
|
+
/**
|
|
283
|
+
* List tracked activities for a resource session
|
|
284
|
+
*/
|
|
285
|
+
getResourceSessionActivitiesRaw(requestParameters, initOverrides) {
|
|
286
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
287
|
+
const requestOptions = yield this.getResourceSessionActivitiesRequestOpts(requestParameters);
|
|
288
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
289
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSessionActivityList_1.GetResourceSessionActivityListFromJSON)(jsonValue));
|
|
290
|
+
});
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* List tracked activities for a resource session
|
|
294
|
+
*/
|
|
295
|
+
getResourceSessionActivities(requestParameters, initOverrides) {
|
|
296
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
297
|
+
const response = yield this.getResourceSessionActivitiesRaw(requestParameters, initOverrides);
|
|
298
|
+
return yield response.value();
|
|
299
|
+
});
|
|
300
|
+
}
|
|
301
|
+
/**
|
|
302
|
+
* Creates request options for getResourceSessionActivityEvents without sending the request
|
|
303
|
+
*/
|
|
304
|
+
getResourceSessionActivityEventsRequestOpts(requestParameters) {
|
|
305
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
306
|
+
if (requestParameters['sessionId'] == null) {
|
|
307
|
+
throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionActivityEvents().');
|
|
308
|
+
}
|
|
309
|
+
const queryParameters = {};
|
|
310
|
+
const headerParameters = {};
|
|
311
|
+
let urlPath = `/resource/sessions/{sessionId}/activity-events`;
|
|
312
|
+
urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
|
|
313
|
+
return {
|
|
314
|
+
path: urlPath,
|
|
315
|
+
method: 'GET',
|
|
316
|
+
headers: headerParameters,
|
|
317
|
+
query: queryParameters,
|
|
318
|
+
};
|
|
319
|
+
});
|
|
320
|
+
}
|
|
321
|
+
/**
|
|
322
|
+
* List recorded learner activity events for a resource session
|
|
323
|
+
*/
|
|
324
|
+
getResourceSessionActivityEventsRaw(requestParameters, initOverrides) {
|
|
325
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
326
|
+
const requestOptions = yield this.getResourceSessionActivityEventsRequestOpts(requestParameters);
|
|
327
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
328
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSessionActivityEventList_1.GetResourceSessionActivityEventListFromJSON)(jsonValue));
|
|
329
|
+
});
|
|
330
|
+
}
|
|
331
|
+
/**
|
|
332
|
+
* List recorded learner activity events for a resource session
|
|
333
|
+
*/
|
|
334
|
+
getResourceSessionActivityEvents(requestParameters, initOverrides) {
|
|
335
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
336
|
+
const response = yield this.getResourceSessionActivityEventsRaw(requestParameters, initOverrides);
|
|
337
|
+
return yield response.value();
|
|
338
|
+
});
|
|
339
|
+
}
|
|
252
340
|
/**
|
|
253
341
|
* Creates request options for getResourceSessionAsset without sending the request
|
|
254
342
|
*/
|
|
@@ -536,6 +624,9 @@ class PlayerApi extends runtime.BaseAPI {
|
|
|
536
624
|
throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionScormData().');
|
|
537
625
|
}
|
|
538
626
|
const queryParameters = {};
|
|
627
|
+
if (requestParameters['activityId'] != null) {
|
|
628
|
+
queryParameters['activity_id'] = requestParameters['activityId'];
|
|
629
|
+
}
|
|
539
630
|
const headerParameters = {};
|
|
540
631
|
let urlPath = `/resource/sessions/{sessionId}/scorm-data`;
|
|
541
632
|
urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
|
|
@@ -575,6 +666,9 @@ class PlayerApi extends runtime.BaseAPI {
|
|
|
575
666
|
throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling initializeResourceScormSession().');
|
|
576
667
|
}
|
|
577
668
|
const queryParameters = {};
|
|
669
|
+
if (requestParameters['activityId'] != null) {
|
|
670
|
+
queryParameters['activity_id'] = requestParameters['activityId'];
|
|
671
|
+
}
|
|
578
672
|
const headerParameters = {};
|
|
579
673
|
let urlPath = `/resource/sessions/{sessionId}/initialize`;
|
|
580
674
|
urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
|
|
@@ -604,6 +698,54 @@ class PlayerApi extends runtime.BaseAPI {
|
|
|
604
698
|
yield this.initializeResourceScormSessionRaw(requestParameters, initOverrides);
|
|
605
699
|
});
|
|
606
700
|
}
|
|
701
|
+
/**
|
|
702
|
+
* Creates request options for postResourceSessionActivityEvent without sending the request
|
|
703
|
+
*/
|
|
704
|
+
postResourceSessionActivityEventRequestOpts(requestParameters) {
|
|
705
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
706
|
+
if (requestParameters['sessionId'] == null) {
|
|
707
|
+
throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling postResourceSessionActivityEvent().');
|
|
708
|
+
}
|
|
709
|
+
if (requestParameters['activityId'] == null) {
|
|
710
|
+
throw new runtime.RequiredError('activityId', 'Required parameter "activityId" was null or undefined when calling postResourceSessionActivityEvent().');
|
|
711
|
+
}
|
|
712
|
+
if (requestParameters['postResourceSessionActivityEvent'] == null) {
|
|
713
|
+
throw new runtime.RequiredError('postResourceSessionActivityEvent', 'Required parameter "postResourceSessionActivityEvent" was null or undefined when calling postResourceSessionActivityEvent().');
|
|
714
|
+
}
|
|
715
|
+
const queryParameters = {};
|
|
716
|
+
const headerParameters = {};
|
|
717
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
718
|
+
let urlPath = `/resource/sessions/{sessionId}/activities/{activityId}/events`;
|
|
719
|
+
urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
|
|
720
|
+
urlPath = urlPath.replace('{activityId}', encodeURIComponent(String(requestParameters['activityId'])));
|
|
721
|
+
return {
|
|
722
|
+
path: urlPath,
|
|
723
|
+
method: 'POST',
|
|
724
|
+
headers: headerParameters,
|
|
725
|
+
query: queryParameters,
|
|
726
|
+
body: (0, PostResourceSessionActivityEvent_1.PostResourceSessionActivityEventToJSON)(requestParameters['postResourceSessionActivityEvent']),
|
|
727
|
+
};
|
|
728
|
+
});
|
|
729
|
+
}
|
|
730
|
+
/**
|
|
731
|
+
* Record learner activity and update active time
|
|
732
|
+
*/
|
|
733
|
+
postResourceSessionActivityEventRaw(requestParameters, initOverrides) {
|
|
734
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
735
|
+
const requestOptions = yield this.postResourceSessionActivityEventRequestOpts(requestParameters);
|
|
736
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
737
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSessionActivity_1.GetResourceSessionActivityFromJSON)(jsonValue));
|
|
738
|
+
});
|
|
739
|
+
}
|
|
740
|
+
/**
|
|
741
|
+
* Record learner activity and update active time
|
|
742
|
+
*/
|
|
743
|
+
postResourceSessionActivityEvent(requestParameters, initOverrides) {
|
|
744
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
745
|
+
const response = yield this.postResourceSessionActivityEventRaw(requestParameters, initOverrides);
|
|
746
|
+
return yield response.value();
|
|
747
|
+
});
|
|
748
|
+
}
|
|
607
749
|
/**
|
|
608
750
|
* Creates request options for postResourceSessionComplete without sending the request
|
|
609
751
|
*/
|
|
@@ -655,6 +797,9 @@ class PlayerApi extends runtime.BaseAPI {
|
|
|
655
797
|
throw new runtime.RequiredError('scormSetValueRequest', 'Required parameter "scormSetValueRequest" was null or undefined when calling setResourceScormValue().');
|
|
656
798
|
}
|
|
657
799
|
const queryParameters = {};
|
|
800
|
+
if (requestParameters['activityId'] != null) {
|
|
801
|
+
queryParameters['activity_id'] = requestParameters['activityId'];
|
|
802
|
+
}
|
|
658
803
|
const headerParameters = {};
|
|
659
804
|
headerParameters['Content-Type'] = 'application/json';
|
|
660
805
|
let urlPath = `/resource/sessions/{sessionId}/set-value`;
|
|
@@ -696,6 +841,9 @@ class PlayerApi extends runtime.BaseAPI {
|
|
|
696
841
|
throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling terminateResourceScormSession().');
|
|
697
842
|
}
|
|
698
843
|
const queryParameters = {};
|
|
844
|
+
if (requestParameters['activityId'] != null) {
|
|
845
|
+
queryParameters['activity_id'] = requestParameters['activityId'];
|
|
846
|
+
}
|
|
699
847
|
const headerParameters = {};
|
|
700
848
|
let urlPath = `/resource/sessions/{sessionId}/terminate`;
|
|
701
849
|
urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
|
|
@@ -11,10 +11,14 @@
|
|
|
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';
|
|
18
22
|
import { type ResourceSessionEnvironment } from '../models/ResourceSessionEnvironment';
|
|
19
23
|
import { type ResourceType } from '../models/ResourceType';
|
|
20
24
|
import { type ScormGetValueResponse } from '../models/ScormGetValueResponse';
|
|
@@ -22,6 +26,7 @@ import { type ScormSetValueRequest } from '../models/ScormSetValueRequest';
|
|
|
22
26
|
import { type ScormSetValueResponse } from '../models/ScormSetValueResponse';
|
|
23
27
|
export interface CommitResourceScormSessionRequest {
|
|
24
28
|
sessionId: string;
|
|
29
|
+
activityId?: string;
|
|
25
30
|
}
|
|
26
31
|
export interface GetCourseVersionResourceAssetRequest {
|
|
27
32
|
courseVersionId: string;
|
|
@@ -34,10 +39,17 @@ export interface GetLibraryQuizSessionPlayerRequest {
|
|
|
34
39
|
export interface GetResourceScormValueRequest {
|
|
35
40
|
sessionId: string;
|
|
36
41
|
key: string;
|
|
42
|
+
activityId?: string;
|
|
37
43
|
}
|
|
38
44
|
export interface GetResourceSessionRequest {
|
|
39
45
|
sessionId: string;
|
|
40
46
|
}
|
|
47
|
+
export interface GetResourceSessionActivitiesRequest {
|
|
48
|
+
sessionId: string;
|
|
49
|
+
}
|
|
50
|
+
export interface GetResourceSessionActivityEventsRequest {
|
|
51
|
+
sessionId: string;
|
|
52
|
+
}
|
|
41
53
|
export interface GetResourceSessionAssetRequest {
|
|
42
54
|
sessionId: string;
|
|
43
55
|
assetPath: string;
|
|
@@ -81,9 +93,16 @@ export interface GetResourceSessionScormApiLogsRequest {
|
|
|
81
93
|
}
|
|
82
94
|
export interface GetResourceSessionScormDataRequest {
|
|
83
95
|
sessionId: string;
|
|
96
|
+
activityId?: string;
|
|
84
97
|
}
|
|
85
98
|
export interface InitializeResourceScormSessionRequest {
|
|
86
99
|
sessionId: string;
|
|
100
|
+
activityId?: string;
|
|
101
|
+
}
|
|
102
|
+
export interface PostResourceSessionActivityEventRequest {
|
|
103
|
+
sessionId: string;
|
|
104
|
+
activityId: string;
|
|
105
|
+
postResourceSessionActivityEvent: PostResourceSessionActivityEvent;
|
|
87
106
|
}
|
|
88
107
|
export interface PostResourceSessionCompleteRequest {
|
|
89
108
|
sessionId: string;
|
|
@@ -91,9 +110,11 @@ export interface PostResourceSessionCompleteRequest {
|
|
|
91
110
|
export interface SetResourceScormValueRequest {
|
|
92
111
|
sessionId: string;
|
|
93
112
|
scormSetValueRequest: ScormSetValueRequest;
|
|
113
|
+
activityId?: string;
|
|
94
114
|
}
|
|
95
115
|
export interface TerminateResourceScormSessionRequest {
|
|
96
116
|
sessionId: string;
|
|
117
|
+
activityId?: string;
|
|
97
118
|
}
|
|
98
119
|
/**
|
|
99
120
|
*
|
|
@@ -159,6 +180,30 @@ export declare class PlayerApi extends runtime.BaseAPI {
|
|
|
159
180
|
* Get a resource session
|
|
160
181
|
*/
|
|
161
182
|
getResourceSession(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
|
|
183
|
+
/**
|
|
184
|
+
* Creates request options for getResourceSessionActivities without sending the request
|
|
185
|
+
*/
|
|
186
|
+
getResourceSessionActivitiesRequestOpts(requestParameters: GetResourceSessionActivitiesRequest): Promise<runtime.RequestOpts>;
|
|
187
|
+
/**
|
|
188
|
+
* List tracked activities for a resource session
|
|
189
|
+
*/
|
|
190
|
+
getResourceSessionActivitiesRaw(requestParameters: GetResourceSessionActivitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionActivityList>>;
|
|
191
|
+
/**
|
|
192
|
+
* List tracked activities for a resource session
|
|
193
|
+
*/
|
|
194
|
+
getResourceSessionActivities(requestParameters: GetResourceSessionActivitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionActivityList>;
|
|
195
|
+
/**
|
|
196
|
+
* Creates request options for getResourceSessionActivityEvents without sending the request
|
|
197
|
+
*/
|
|
198
|
+
getResourceSessionActivityEventsRequestOpts(requestParameters: GetResourceSessionActivityEventsRequest): Promise<runtime.RequestOpts>;
|
|
199
|
+
/**
|
|
200
|
+
* List recorded learner activity events for a resource session
|
|
201
|
+
*/
|
|
202
|
+
getResourceSessionActivityEventsRaw(requestParameters: GetResourceSessionActivityEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionActivityEventList>>;
|
|
203
|
+
/**
|
|
204
|
+
* List recorded learner activity events for a resource session
|
|
205
|
+
*/
|
|
206
|
+
getResourceSessionActivityEvents(requestParameters: GetResourceSessionActivityEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionActivityEventList>;
|
|
162
207
|
/**
|
|
163
208
|
* Creates request options for getResourceSessionAsset without sending the request
|
|
164
209
|
*/
|
|
@@ -243,6 +288,18 @@ export declare class PlayerApi extends runtime.BaseAPI {
|
|
|
243
288
|
* Initialize a reusable SCORM resource session
|
|
244
289
|
*/
|
|
245
290
|
initializeResourceScormSession(requestParameters: InitializeResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
291
|
+
/**
|
|
292
|
+
* Creates request options for postResourceSessionActivityEvent without sending the request
|
|
293
|
+
*/
|
|
294
|
+
postResourceSessionActivityEventRequestOpts(requestParameters: PostResourceSessionActivityEventRequest): Promise<runtime.RequestOpts>;
|
|
295
|
+
/**
|
|
296
|
+
* Record learner activity and update active time
|
|
297
|
+
*/
|
|
298
|
+
postResourceSessionActivityEventRaw(requestParameters: PostResourceSessionActivityEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionActivity>>;
|
|
299
|
+
/**
|
|
300
|
+
* Record learner activity and update active time
|
|
301
|
+
*/
|
|
302
|
+
postResourceSessionActivityEvent(requestParameters: PostResourceSessionActivityEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionActivity>;
|
|
246
303
|
/**
|
|
247
304
|
* Creates request options for postResourceSessionComplete without sending the request
|
|
248
305
|
*/
|