@easyedu/js-lsm-api 1.89.0 → 1.90.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 +8 -0
- package/README.md +11 -2
- package/dist/apis/ContentLibraryApi.d.ts +19 -0
- package/dist/apis/ContentLibraryApi.js +47 -0
- package/dist/apis/PlayerApi.d.ts +73 -0
- package/dist/apis/PlayerApi.js +188 -0
- package/dist/esm/apis/ContentLibraryApi.d.ts +19 -0
- package/dist/esm/apis/ContentLibraryApi.js +47 -0
- package/dist/esm/apis/PlayerApi.d.ts +73 -0
- package/dist/esm/apis/PlayerApi.js +188 -0
- package/dist/esm/models/GetCourseVersionItemSession.d.ts +7 -0
- package/dist/esm/models/GetCourseVersionItemSession.js +5 -0
- package/dist/esm/models/GetResourceSession.d.ts +161 -0
- package/dist/esm/models/GetResourceSession.js +112 -0
- package/dist/esm/models/GetResourceSessionList.d.ts +57 -0
- package/dist/esm/models/GetResourceSessionList.js +60 -0
- package/dist/esm/models/PostResourceVersionSession.d.ts +32 -0
- package/dist/esm/models/PostResourceVersionSession.js +41 -0
- package/dist/esm/models/ResourceSessionEnvironment.d.ts +25 -0
- package/dist/esm/models/ResourceSessionEnvironment.js +43 -0
- package/dist/esm/models/index.d.ts +4 -0
- package/dist/esm/models/index.js +4 -0
- package/dist/models/GetCourseVersionItemSession.d.ts +7 -0
- package/dist/models/GetCourseVersionItemSession.js +5 -0
- package/dist/models/GetResourceSession.d.ts +161 -0
- package/dist/models/GetResourceSession.js +119 -0
- package/dist/models/GetResourceSessionList.d.ts +57 -0
- package/dist/models/GetResourceSessionList.js +67 -0
- package/dist/models/PostResourceVersionSession.d.ts +32 -0
- package/dist/models/PostResourceVersionSession.js +48 -0
- package/dist/models/ResourceSessionEnvironment.d.ts +25 -0
- package/dist/models/ResourceSessionEnvironment.js +51 -0
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/docs/ContentLibraryApi.md +73 -0
- package/docs/GetCourseVersionItemSession.md +2 -0
- package/docs/GetResourceSession.md +77 -0
- package/docs/GetResourceSessionList.md +43 -0
- package/docs/PlayerApi.md +296 -0
- package/docs/PostResourceVersionSession.md +35 -0
- package/docs/ResourceSessionEnvironment.md +33 -0
- package/package.json +1 -1
- package/src/apis/ContentLibraryApi.ts +72 -0
- package/src/apis/PlayerApi.ts +261 -0
- package/src/models/GetCourseVersionItemSession.ts +16 -0
- package/src/models/GetResourceSession.ts +270 -0
- package/src/models/GetResourceSessionList.ts +110 -0
- package/src/models/PostResourceVersionSession.ts +65 -0
- package/src/models/ResourceSessionEnvironment.ts +53 -0
- package/src/models/index.ts +4 -0
|
@@ -10,6 +10,9 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
+
import { type GetResourceSession } from '../models/GetResourceSession';
|
|
14
|
+
import { type GetResourceSessionList } from '../models/GetResourceSessionList';
|
|
15
|
+
import { type ResourceSessionEnvironment } from '../models/ResourceSessionEnvironment';
|
|
13
16
|
import { type ScormGetValueResponse } from '../models/ScormGetValueResponse';
|
|
14
17
|
import { type ScormSetValueRequest } from '../models/ScormSetValueRequest';
|
|
15
18
|
import { type ScormSetValueResponse } from '../models/ScormSetValueResponse';
|
|
@@ -46,6 +49,25 @@ export interface GetResourceScormValueRequest {
|
|
|
46
49
|
sessionId: string;
|
|
47
50
|
key: string;
|
|
48
51
|
}
|
|
52
|
+
export interface GetResourceSessionRequest {
|
|
53
|
+
sessionId: string;
|
|
54
|
+
}
|
|
55
|
+
export interface GetResourceSessionAssetRequest {
|
|
56
|
+
sessionId: string;
|
|
57
|
+
assetPath: string;
|
|
58
|
+
}
|
|
59
|
+
export interface GetResourceSessionListRequest {
|
|
60
|
+
userId?: string;
|
|
61
|
+
resourceId?: string;
|
|
62
|
+
versionId?: string;
|
|
63
|
+
courseId?: string;
|
|
64
|
+
environment?: ResourceSessionEnvironment;
|
|
65
|
+
completionStatus?: string;
|
|
66
|
+
createdFrom?: number;
|
|
67
|
+
createdTo?: number;
|
|
68
|
+
page?: number;
|
|
69
|
+
pageSize?: number;
|
|
70
|
+
}
|
|
49
71
|
export interface GetResourceSessionPlayerRequest {
|
|
50
72
|
sessionId: string;
|
|
51
73
|
}
|
|
@@ -65,6 +87,9 @@ export interface GetVideoPlayerRequest {
|
|
|
65
87
|
export interface InitializeResourceScormSessionRequest {
|
|
66
88
|
sessionId: string;
|
|
67
89
|
}
|
|
90
|
+
export interface PostResourceSessionCompleteRequest {
|
|
91
|
+
sessionId: string;
|
|
92
|
+
}
|
|
68
93
|
export interface SetResourceScormValueRequest {
|
|
69
94
|
sessionId: string;
|
|
70
95
|
scormSetValueRequest: ScormSetValueRequest;
|
|
@@ -196,6 +221,42 @@ export declare class PlayerApi extends runtime.BaseAPI {
|
|
|
196
221
|
* Read a CMI value from a reusable SCORM resource session
|
|
197
222
|
*/
|
|
198
223
|
getResourceScormValue(requestParameters: GetResourceScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScormGetValueResponse>;
|
|
224
|
+
/**
|
|
225
|
+
* Creates request options for getResourceSession without sending the request
|
|
226
|
+
*/
|
|
227
|
+
getResourceSessionRequestOpts(requestParameters: GetResourceSessionRequest): Promise<runtime.RequestOpts>;
|
|
228
|
+
/**
|
|
229
|
+
* Get a resource session
|
|
230
|
+
*/
|
|
231
|
+
getResourceSessionRaw(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>>;
|
|
232
|
+
/**
|
|
233
|
+
* Get a resource session
|
|
234
|
+
*/
|
|
235
|
+
getResourceSession(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
|
|
236
|
+
/**
|
|
237
|
+
* Creates request options for getResourceSessionAsset without sending the request
|
|
238
|
+
*/
|
|
239
|
+
getResourceSessionAssetRequestOpts(requestParameters: GetResourceSessionAssetRequest): Promise<runtime.RequestOpts>;
|
|
240
|
+
/**
|
|
241
|
+
* Stream an asset pinned to a resource session
|
|
242
|
+
*/
|
|
243
|
+
getResourceSessionAssetRaw(requestParameters: GetResourceSessionAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
244
|
+
/**
|
|
245
|
+
* Stream an asset pinned to a resource session
|
|
246
|
+
*/
|
|
247
|
+
getResourceSessionAsset(requestParameters: GetResourceSessionAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
248
|
+
/**
|
|
249
|
+
* Creates request options for getResourceSessionList without sending the request
|
|
250
|
+
*/
|
|
251
|
+
getResourceSessionListRequestOpts(requestParameters: GetResourceSessionListRequest): Promise<runtime.RequestOpts>;
|
|
252
|
+
/**
|
|
253
|
+
* List resource sessions for the selected portal
|
|
254
|
+
*/
|
|
255
|
+
getResourceSessionListRaw(requestParameters: GetResourceSessionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionList>>;
|
|
256
|
+
/**
|
|
257
|
+
* List resource sessions for the selected portal
|
|
258
|
+
*/
|
|
259
|
+
getResourceSessionList(requestParameters?: GetResourceSessionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionList>;
|
|
199
260
|
/**
|
|
200
261
|
* Creates request options for getResourceSessionPlayer without sending the request
|
|
201
262
|
*/
|
|
@@ -268,6 +329,18 @@ export declare class PlayerApi extends runtime.BaseAPI {
|
|
|
268
329
|
* Initialize a reusable SCORM resource session
|
|
269
330
|
*/
|
|
270
331
|
initializeResourceScormSession(requestParameters: InitializeResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
332
|
+
/**
|
|
333
|
+
* Creates request options for postResourceSessionComplete without sending the request
|
|
334
|
+
*/
|
|
335
|
+
postResourceSessionCompleteRequestOpts(requestParameters: PostResourceSessionCompleteRequest): Promise<runtime.RequestOpts>;
|
|
336
|
+
/**
|
|
337
|
+
* Complete a non-SCORM resource session
|
|
338
|
+
*/
|
|
339
|
+
postResourceSessionCompleteRaw(requestParameters: PostResourceSessionCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>>;
|
|
340
|
+
/**
|
|
341
|
+
* Complete a non-SCORM resource session
|
|
342
|
+
*/
|
|
343
|
+
postResourceSessionComplete(requestParameters: PostResourceSessionCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
|
|
271
344
|
/**
|
|
272
345
|
* Creates request options for setResourceScormValue without sending the request
|
|
273
346
|
*/
|
|
@@ -21,6 +21,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
});
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
|
+
import { GetResourceSessionFromJSON, } from '../models/GetResourceSession';
|
|
25
|
+
import { GetResourceSessionListFromJSON, } from '../models/GetResourceSessionList';
|
|
24
26
|
import { ScormGetValueResponseFromJSON, } from '../models/ScormGetValueResponse';
|
|
25
27
|
import { ScormSetValueRequestToJSON, } from '../models/ScormSetValueRequest';
|
|
26
28
|
import { ScormSetValueResponseFromJSON, } from '../models/ScormSetValueResponse';
|
|
@@ -424,6 +426,153 @@ export class PlayerApi extends runtime.BaseAPI {
|
|
|
424
426
|
return yield response.value();
|
|
425
427
|
});
|
|
426
428
|
}
|
|
429
|
+
/**
|
|
430
|
+
* Creates request options for getResourceSession without sending the request
|
|
431
|
+
*/
|
|
432
|
+
getResourceSessionRequestOpts(requestParameters) {
|
|
433
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
434
|
+
if (requestParameters['sessionId'] == null) {
|
|
435
|
+
throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSession().');
|
|
436
|
+
}
|
|
437
|
+
const queryParameters = {};
|
|
438
|
+
const headerParameters = {};
|
|
439
|
+
let urlPath = `/resource/sessions/{sessionId}`;
|
|
440
|
+
urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
|
|
441
|
+
return {
|
|
442
|
+
path: urlPath,
|
|
443
|
+
method: 'GET',
|
|
444
|
+
headers: headerParameters,
|
|
445
|
+
query: queryParameters,
|
|
446
|
+
};
|
|
447
|
+
});
|
|
448
|
+
}
|
|
449
|
+
/**
|
|
450
|
+
* Get a resource session
|
|
451
|
+
*/
|
|
452
|
+
getResourceSessionRaw(requestParameters, initOverrides) {
|
|
453
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
454
|
+
const requestOptions = yield this.getResourceSessionRequestOpts(requestParameters);
|
|
455
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
456
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionFromJSON(jsonValue));
|
|
457
|
+
});
|
|
458
|
+
}
|
|
459
|
+
/**
|
|
460
|
+
* Get a resource session
|
|
461
|
+
*/
|
|
462
|
+
getResourceSession(requestParameters, initOverrides) {
|
|
463
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
464
|
+
const response = yield this.getResourceSessionRaw(requestParameters, initOverrides);
|
|
465
|
+
return yield response.value();
|
|
466
|
+
});
|
|
467
|
+
}
|
|
468
|
+
/**
|
|
469
|
+
* Creates request options for getResourceSessionAsset without sending the request
|
|
470
|
+
*/
|
|
471
|
+
getResourceSessionAssetRequestOpts(requestParameters) {
|
|
472
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
473
|
+
if (requestParameters['sessionId'] == null) {
|
|
474
|
+
throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionAsset().');
|
|
475
|
+
}
|
|
476
|
+
if (requestParameters['assetPath'] == null) {
|
|
477
|
+
throw new runtime.RequiredError('assetPath', 'Required parameter "assetPath" was null or undefined when calling getResourceSessionAsset().');
|
|
478
|
+
}
|
|
479
|
+
const queryParameters = {};
|
|
480
|
+
const headerParameters = {};
|
|
481
|
+
let urlPath = `/resource/sessions/{sessionId}/asset/{assetPath}`;
|
|
482
|
+
urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
|
|
483
|
+
urlPath = urlPath.replace('{assetPath}', encodeURIComponent(String(requestParameters['assetPath'])));
|
|
484
|
+
return {
|
|
485
|
+
path: urlPath,
|
|
486
|
+
method: 'GET',
|
|
487
|
+
headers: headerParameters,
|
|
488
|
+
query: queryParameters,
|
|
489
|
+
};
|
|
490
|
+
});
|
|
491
|
+
}
|
|
492
|
+
/**
|
|
493
|
+
* Stream an asset pinned to a resource session
|
|
494
|
+
*/
|
|
495
|
+
getResourceSessionAssetRaw(requestParameters, initOverrides) {
|
|
496
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
497
|
+
const requestOptions = yield this.getResourceSessionAssetRequestOpts(requestParameters);
|
|
498
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
499
|
+
return new runtime.BlobApiResponse(response);
|
|
500
|
+
});
|
|
501
|
+
}
|
|
502
|
+
/**
|
|
503
|
+
* Stream an asset pinned to a resource session
|
|
504
|
+
*/
|
|
505
|
+
getResourceSessionAsset(requestParameters, initOverrides) {
|
|
506
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
507
|
+
const response = yield this.getResourceSessionAssetRaw(requestParameters, initOverrides);
|
|
508
|
+
return yield response.value();
|
|
509
|
+
});
|
|
510
|
+
}
|
|
511
|
+
/**
|
|
512
|
+
* Creates request options for getResourceSessionList without sending the request
|
|
513
|
+
*/
|
|
514
|
+
getResourceSessionListRequestOpts(requestParameters) {
|
|
515
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
516
|
+
const queryParameters = {};
|
|
517
|
+
if (requestParameters['userId'] != null) {
|
|
518
|
+
queryParameters['user_id'] = requestParameters['userId'];
|
|
519
|
+
}
|
|
520
|
+
if (requestParameters['resourceId'] != null) {
|
|
521
|
+
queryParameters['resource_id'] = requestParameters['resourceId'];
|
|
522
|
+
}
|
|
523
|
+
if (requestParameters['versionId'] != null) {
|
|
524
|
+
queryParameters['version_id'] = requestParameters['versionId'];
|
|
525
|
+
}
|
|
526
|
+
if (requestParameters['courseId'] != null) {
|
|
527
|
+
queryParameters['course_id'] = requestParameters['courseId'];
|
|
528
|
+
}
|
|
529
|
+
if (requestParameters['environment'] != null) {
|
|
530
|
+
queryParameters['environment'] = requestParameters['environment'];
|
|
531
|
+
}
|
|
532
|
+
if (requestParameters['completionStatus'] != null) {
|
|
533
|
+
queryParameters['completion_status'] = requestParameters['completionStatus'];
|
|
534
|
+
}
|
|
535
|
+
if (requestParameters['createdFrom'] != null) {
|
|
536
|
+
queryParameters['created_from'] = requestParameters['createdFrom'];
|
|
537
|
+
}
|
|
538
|
+
if (requestParameters['createdTo'] != null) {
|
|
539
|
+
queryParameters['created_to'] = requestParameters['createdTo'];
|
|
540
|
+
}
|
|
541
|
+
if (requestParameters['page'] != null) {
|
|
542
|
+
queryParameters['page'] = requestParameters['page'];
|
|
543
|
+
}
|
|
544
|
+
if (requestParameters['pageSize'] != null) {
|
|
545
|
+
queryParameters['pageSize'] = requestParameters['pageSize'];
|
|
546
|
+
}
|
|
547
|
+
const headerParameters = {};
|
|
548
|
+
let urlPath = `/resource/sessions`;
|
|
549
|
+
return {
|
|
550
|
+
path: urlPath,
|
|
551
|
+
method: 'GET',
|
|
552
|
+
headers: headerParameters,
|
|
553
|
+
query: queryParameters,
|
|
554
|
+
};
|
|
555
|
+
});
|
|
556
|
+
}
|
|
557
|
+
/**
|
|
558
|
+
* List resource sessions for the selected portal
|
|
559
|
+
*/
|
|
560
|
+
getResourceSessionListRaw(requestParameters, initOverrides) {
|
|
561
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
562
|
+
const requestOptions = yield this.getResourceSessionListRequestOpts(requestParameters);
|
|
563
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
564
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionListFromJSON(jsonValue));
|
|
565
|
+
});
|
|
566
|
+
}
|
|
567
|
+
/**
|
|
568
|
+
* List resource sessions for the selected portal
|
|
569
|
+
*/
|
|
570
|
+
getResourceSessionList() {
|
|
571
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
572
|
+
const response = yield this.getResourceSessionListRaw(requestParameters, initOverrides);
|
|
573
|
+
return yield response.value();
|
|
574
|
+
});
|
|
575
|
+
}
|
|
427
576
|
/**
|
|
428
577
|
* Creates request options for getResourceSessionPlayer without sending the request
|
|
429
578
|
*/
|
|
@@ -662,6 +811,45 @@ export class PlayerApi extends runtime.BaseAPI {
|
|
|
662
811
|
yield this.initializeResourceScormSessionRaw(requestParameters, initOverrides);
|
|
663
812
|
});
|
|
664
813
|
}
|
|
814
|
+
/**
|
|
815
|
+
* Creates request options for postResourceSessionComplete without sending the request
|
|
816
|
+
*/
|
|
817
|
+
postResourceSessionCompleteRequestOpts(requestParameters) {
|
|
818
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
819
|
+
if (requestParameters['sessionId'] == null) {
|
|
820
|
+
throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling postResourceSessionComplete().');
|
|
821
|
+
}
|
|
822
|
+
const queryParameters = {};
|
|
823
|
+
const headerParameters = {};
|
|
824
|
+
let urlPath = `/resource/sessions/{sessionId}/complete`;
|
|
825
|
+
urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
|
|
826
|
+
return {
|
|
827
|
+
path: urlPath,
|
|
828
|
+
method: 'POST',
|
|
829
|
+
headers: headerParameters,
|
|
830
|
+
query: queryParameters,
|
|
831
|
+
};
|
|
832
|
+
});
|
|
833
|
+
}
|
|
834
|
+
/**
|
|
835
|
+
* Complete a non-SCORM resource session
|
|
836
|
+
*/
|
|
837
|
+
postResourceSessionCompleteRaw(requestParameters, initOverrides) {
|
|
838
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
839
|
+
const requestOptions = yield this.postResourceSessionCompleteRequestOpts(requestParameters);
|
|
840
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
841
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionFromJSON(jsonValue));
|
|
842
|
+
});
|
|
843
|
+
}
|
|
844
|
+
/**
|
|
845
|
+
* Complete a non-SCORM resource session
|
|
846
|
+
*/
|
|
847
|
+
postResourceSessionComplete(requestParameters, initOverrides) {
|
|
848
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
849
|
+
const response = yield this.postResourceSessionCompleteRaw(requestParameters, initOverrides);
|
|
850
|
+
return yield response.value();
|
|
851
|
+
});
|
|
852
|
+
}
|
|
665
853
|
/**
|
|
666
854
|
* Creates request options for setResourceScormValue without sending the request
|
|
667
855
|
*/
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { ResourceSessionEnvironment } from './ResourceSessionEnvironment';
|
|
12
13
|
import type { ResourceType } from './ResourceType';
|
|
13
14
|
import type { ContentLaunchMode } from './ContentLaunchMode';
|
|
14
15
|
/**
|
|
@@ -23,6 +24,12 @@ export interface GetCourseVersionItemSession {
|
|
|
23
24
|
* @memberof GetCourseVersionItemSession
|
|
24
25
|
*/
|
|
25
26
|
id: string;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {ResourceSessionEnvironment}
|
|
30
|
+
* @memberof GetCourseVersionItemSession
|
|
31
|
+
*/
|
|
32
|
+
environment: ResourceSessionEnvironment;
|
|
26
33
|
/**
|
|
27
34
|
*
|
|
28
35
|
* @type {string}
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
import { ResourceSessionEnvironmentFromJSON, ResourceSessionEnvironmentToJSON, } from './ResourceSessionEnvironment';
|
|
14
15
|
import { ResourceTypeFromJSON, ResourceTypeToJSON, } from './ResourceType';
|
|
15
16
|
import { ContentLaunchModeFromJSON, ContentLaunchModeToJSON, } from './ContentLaunchMode';
|
|
16
17
|
/**
|
|
@@ -19,6 +20,8 @@ import { ContentLaunchModeFromJSON, ContentLaunchModeToJSON, } from './ContentLa
|
|
|
19
20
|
export function instanceOfGetCourseVersionItemSession(value) {
|
|
20
21
|
if (!('id' in value) || value['id'] === undefined)
|
|
21
22
|
return false;
|
|
23
|
+
if (!('environment' in value) || value['environment'] === undefined)
|
|
24
|
+
return false;
|
|
22
25
|
if (!('courseVersionId' in value) || value['courseVersionId'] === undefined)
|
|
23
26
|
return false;
|
|
24
27
|
if (!('itemId' in value) || value['itemId'] === undefined)
|
|
@@ -56,6 +59,7 @@ export function GetCourseVersionItemSessionFromJSONTyped(json, ignoreDiscriminat
|
|
|
56
59
|
}
|
|
57
60
|
return {
|
|
58
61
|
'id': json['id'],
|
|
62
|
+
'environment': ResourceSessionEnvironmentFromJSON(json['environment']),
|
|
59
63
|
'courseVersionId': json['course_version_id'],
|
|
60
64
|
'itemId': json['item_id'],
|
|
61
65
|
'contentLibraryItemId': json['content_library_item_id'],
|
|
@@ -82,6 +86,7 @@ export function GetCourseVersionItemSessionToJSONTyped(value, ignoreDiscriminato
|
|
|
82
86
|
}
|
|
83
87
|
return {
|
|
84
88
|
'id': value['id'],
|
|
89
|
+
'environment': ResourceSessionEnvironmentToJSON(value['environment']),
|
|
85
90
|
'course_version_id': value['courseVersionId'],
|
|
86
91
|
'item_id': value['itemId'],
|
|
87
92
|
'content_library_item_id': value['contentLibraryItemId'],
|
|
@@ -0,0 +1,161 @@
|
|
|
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
|
+
import type { ResourceSessionEnvironment } from './ResourceSessionEnvironment';
|
|
13
|
+
import type { ResourceType } from './ResourceType';
|
|
14
|
+
import type { ContentLaunchMode } from './ContentLaunchMode';
|
|
15
|
+
/**
|
|
16
|
+
* A user-owned session pinned to an immutable Content Library resource version.
|
|
17
|
+
* @export
|
|
18
|
+
* @interface GetResourceSession
|
|
19
|
+
*/
|
|
20
|
+
export interface GetResourceSession {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {string}
|
|
24
|
+
* @memberof GetResourceSession
|
|
25
|
+
*/
|
|
26
|
+
id: string;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {string}
|
|
30
|
+
* @memberof GetResourceSession
|
|
31
|
+
*/
|
|
32
|
+
userId: string;
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
* @type {ResourceSessionEnvironment}
|
|
36
|
+
* @memberof GetResourceSession
|
|
37
|
+
*/
|
|
38
|
+
environment: ResourceSessionEnvironment;
|
|
39
|
+
/**
|
|
40
|
+
*
|
|
41
|
+
* @type {string}
|
|
42
|
+
* @memberof GetResourceSession
|
|
43
|
+
*/
|
|
44
|
+
courseId?: string | null;
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @type {string}
|
|
48
|
+
* @memberof GetResourceSession
|
|
49
|
+
*/
|
|
50
|
+
courseVersionId?: string | null;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof GetResourceSession
|
|
55
|
+
*/
|
|
56
|
+
itemId?: string | null;
|
|
57
|
+
/**
|
|
58
|
+
*
|
|
59
|
+
* @type {string}
|
|
60
|
+
* @memberof GetResourceSession
|
|
61
|
+
*/
|
|
62
|
+
contentLibraryItemId: string;
|
|
63
|
+
/**
|
|
64
|
+
*
|
|
65
|
+
* @type {string}
|
|
66
|
+
* @memberof GetResourceSession
|
|
67
|
+
*/
|
|
68
|
+
contentLibraryVersionId: string;
|
|
69
|
+
/**
|
|
70
|
+
*
|
|
71
|
+
* @type {string}
|
|
72
|
+
* @memberof GetResourceSession
|
|
73
|
+
*/
|
|
74
|
+
resourceName: string;
|
|
75
|
+
/**
|
|
76
|
+
*
|
|
77
|
+
* @type {ResourceType}
|
|
78
|
+
* @memberof GetResourceSession
|
|
79
|
+
*/
|
|
80
|
+
resourceType: ResourceType;
|
|
81
|
+
/**
|
|
82
|
+
*
|
|
83
|
+
* @type {ContentLaunchMode}
|
|
84
|
+
* @memberof GetResourceSession
|
|
85
|
+
*/
|
|
86
|
+
launchMode?: ContentLaunchMode | null;
|
|
87
|
+
/**
|
|
88
|
+
*
|
|
89
|
+
* @type {string}
|
|
90
|
+
* @memberof GetResourceSession
|
|
91
|
+
*/
|
|
92
|
+
launchUrl?: string | null;
|
|
93
|
+
/**
|
|
94
|
+
*
|
|
95
|
+
* @type {number}
|
|
96
|
+
* @memberof GetResourceSession
|
|
97
|
+
*/
|
|
98
|
+
attemptNumber: number;
|
|
99
|
+
/**
|
|
100
|
+
*
|
|
101
|
+
* @type {boolean}
|
|
102
|
+
* @memberof GetResourceSession
|
|
103
|
+
*/
|
|
104
|
+
isCurrent: boolean;
|
|
105
|
+
/**
|
|
106
|
+
*
|
|
107
|
+
* @type {string}
|
|
108
|
+
* @memberof GetResourceSession
|
|
109
|
+
*/
|
|
110
|
+
completionStatus: string;
|
|
111
|
+
/**
|
|
112
|
+
*
|
|
113
|
+
* @type {string}
|
|
114
|
+
* @memberof GetResourceSession
|
|
115
|
+
*/
|
|
116
|
+
gradeStatus: string;
|
|
117
|
+
/**
|
|
118
|
+
*
|
|
119
|
+
* @type {number}
|
|
120
|
+
* @memberof GetResourceSession
|
|
121
|
+
*/
|
|
122
|
+
scoreRaw?: number | null;
|
|
123
|
+
/**
|
|
124
|
+
*
|
|
125
|
+
* @type {number}
|
|
126
|
+
* @memberof GetResourceSession
|
|
127
|
+
*/
|
|
128
|
+
initializedAt?: number | null;
|
|
129
|
+
/**
|
|
130
|
+
*
|
|
131
|
+
* @type {number}
|
|
132
|
+
* @memberof GetResourceSession
|
|
133
|
+
*/
|
|
134
|
+
terminatedAt?: number | null;
|
|
135
|
+
/**
|
|
136
|
+
*
|
|
137
|
+
* @type {number}
|
|
138
|
+
* @memberof GetResourceSession
|
|
139
|
+
*/
|
|
140
|
+
createdAt: number;
|
|
141
|
+
/**
|
|
142
|
+
*
|
|
143
|
+
* @type {number}
|
|
144
|
+
* @memberof GetResourceSession
|
|
145
|
+
*/
|
|
146
|
+
updatedAt: number;
|
|
147
|
+
/**
|
|
148
|
+
*
|
|
149
|
+
* @type {number}
|
|
150
|
+
* @memberof GetResourceSession
|
|
151
|
+
*/
|
|
152
|
+
completedAt?: number | null;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* Check if a given object implements the GetResourceSession interface.
|
|
156
|
+
*/
|
|
157
|
+
export declare function instanceOfGetResourceSession(value: object): value is GetResourceSession;
|
|
158
|
+
export declare function GetResourceSessionFromJSON(json: any): GetResourceSession;
|
|
159
|
+
export declare function GetResourceSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSession;
|
|
160
|
+
export declare function GetResourceSessionToJSON(json: any): GetResourceSession;
|
|
161
|
+
export declare function GetResourceSessionToJSONTyped(value?: GetResourceSession | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* LMS API
|
|
5
|
+
* LMS API
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { ResourceSessionEnvironmentFromJSON, ResourceSessionEnvironmentToJSON, } from './ResourceSessionEnvironment';
|
|
15
|
+
import { ResourceTypeFromJSON, ResourceTypeToJSON, } from './ResourceType';
|
|
16
|
+
import { ContentLaunchModeFromJSON, ContentLaunchModeToJSON, } from './ContentLaunchMode';
|
|
17
|
+
/**
|
|
18
|
+
* Check if a given object implements the GetResourceSession interface.
|
|
19
|
+
*/
|
|
20
|
+
export function instanceOfGetResourceSession(value) {
|
|
21
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
if (!('userId' in value) || value['userId'] === undefined)
|
|
24
|
+
return false;
|
|
25
|
+
if (!('environment' in value) || value['environment'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('contentLibraryItemId' in value) || value['contentLibraryItemId'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('contentLibraryVersionId' in value) || value['contentLibraryVersionId'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('resourceName' in value) || value['resourceName'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('resourceType' in value) || value['resourceType'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('attemptNumber' in value) || value['attemptNumber'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('isCurrent' in value) || value['isCurrent'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('completionStatus' in value) || value['completionStatus'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('gradeStatus' in value) || value['gradeStatus'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('createdAt' in value) || value['createdAt'] === undefined)
|
|
44
|
+
return false;
|
|
45
|
+
if (!('updatedAt' in value) || value['updatedAt'] === undefined)
|
|
46
|
+
return false;
|
|
47
|
+
return true;
|
|
48
|
+
}
|
|
49
|
+
export function GetResourceSessionFromJSON(json) {
|
|
50
|
+
return GetResourceSessionFromJSONTyped(json, false);
|
|
51
|
+
}
|
|
52
|
+
export function GetResourceSessionFromJSONTyped(json, ignoreDiscriminator) {
|
|
53
|
+
if (json == null) {
|
|
54
|
+
return json;
|
|
55
|
+
}
|
|
56
|
+
return {
|
|
57
|
+
'id': json['id'],
|
|
58
|
+
'userId': json['user_id'],
|
|
59
|
+
'environment': ResourceSessionEnvironmentFromJSON(json['environment']),
|
|
60
|
+
'courseId': json['course_id'] == null ? undefined : json['course_id'],
|
|
61
|
+
'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
|
|
62
|
+
'itemId': json['item_id'] == null ? undefined : json['item_id'],
|
|
63
|
+
'contentLibraryItemId': json['content_library_item_id'],
|
|
64
|
+
'contentLibraryVersionId': json['content_library_version_id'],
|
|
65
|
+
'resourceName': json['resource_name'],
|
|
66
|
+
'resourceType': ResourceTypeFromJSON(json['resource_type']),
|
|
67
|
+
'launchMode': json['launch_mode'] == null ? undefined : ContentLaunchModeFromJSON(json['launch_mode']),
|
|
68
|
+
'launchUrl': json['launch_url'] == null ? undefined : json['launch_url'],
|
|
69
|
+
'attemptNumber': json['attempt_number'],
|
|
70
|
+
'isCurrent': json['is_current'],
|
|
71
|
+
'completionStatus': json['completion_status'],
|
|
72
|
+
'gradeStatus': json['grade_status'],
|
|
73
|
+
'scoreRaw': json['score_raw'] == null ? undefined : json['score_raw'],
|
|
74
|
+
'initializedAt': json['initialized_at'] == null ? undefined : json['initialized_at'],
|
|
75
|
+
'terminatedAt': json['terminated_at'] == null ? undefined : json['terminated_at'],
|
|
76
|
+
'createdAt': json['created_at'],
|
|
77
|
+
'updatedAt': json['updated_at'],
|
|
78
|
+
'completedAt': json['completed_at'] == null ? undefined : json['completed_at'],
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
export function GetResourceSessionToJSON(json) {
|
|
82
|
+
return GetResourceSessionToJSONTyped(json, false);
|
|
83
|
+
}
|
|
84
|
+
export function GetResourceSessionToJSONTyped(value, ignoreDiscriminator = false) {
|
|
85
|
+
if (value == null) {
|
|
86
|
+
return value;
|
|
87
|
+
}
|
|
88
|
+
return {
|
|
89
|
+
'id': value['id'],
|
|
90
|
+
'user_id': value['userId'],
|
|
91
|
+
'environment': ResourceSessionEnvironmentToJSON(value['environment']),
|
|
92
|
+
'course_id': value['courseId'],
|
|
93
|
+
'course_version_id': value['courseVersionId'],
|
|
94
|
+
'item_id': value['itemId'],
|
|
95
|
+
'content_library_item_id': value['contentLibraryItemId'],
|
|
96
|
+
'content_library_version_id': value['contentLibraryVersionId'],
|
|
97
|
+
'resource_name': value['resourceName'],
|
|
98
|
+
'resource_type': ResourceTypeToJSON(value['resourceType']),
|
|
99
|
+
'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
|
|
100
|
+
'launch_url': value['launchUrl'],
|
|
101
|
+
'attempt_number': value['attemptNumber'],
|
|
102
|
+
'is_current': value['isCurrent'],
|
|
103
|
+
'completion_status': value['completionStatus'],
|
|
104
|
+
'grade_status': value['gradeStatus'],
|
|
105
|
+
'score_raw': value['scoreRaw'],
|
|
106
|
+
'initialized_at': value['initializedAt'],
|
|
107
|
+
'terminated_at': value['terminatedAt'],
|
|
108
|
+
'created_at': value['createdAt'],
|
|
109
|
+
'updated_at': value['updatedAt'],
|
|
110
|
+
'completed_at': value['completedAt'],
|
|
111
|
+
};
|
|
112
|
+
}
|