@easyedu/js-lsm-api 1.89.0 → 1.91.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 +28 -0
  2. package/README.md +24 -2
  3. package/dist/apis/ContentLibraryApi.d.ts +19 -0
  4. package/dist/apis/ContentLibraryApi.js +47 -0
  5. package/dist/apis/PlayerApi.d.ts +187 -0
  6. package/dist/apis/PlayerApi.js +401 -1
  7. package/dist/esm/apis/ContentLibraryApi.d.ts +19 -0
  8. package/dist/esm/apis/ContentLibraryApi.js +47 -0
  9. package/dist/esm/apis/PlayerApi.d.ts +187 -0
  10. package/dist/esm/apis/PlayerApi.js +400 -0
  11. package/dist/esm/models/GetCourseVersionItemSession.d.ts +7 -0
  12. package/dist/esm/models/GetCourseVersionItemSession.js +5 -0
  13. package/dist/esm/models/GetResourceSession.d.ts +191 -0
  14. package/dist/esm/models/GetResourceSession.js +128 -0
  15. package/dist/esm/models/GetResourceSessionDiagnostics.d.ts +76 -0
  16. package/dist/esm/models/GetResourceSessionDiagnostics.js +69 -0
  17. package/dist/esm/models/GetResourceSessionDiagnosticsCourseContext.d.ts +81 -0
  18. package/dist/esm/models/GetResourceSessionDiagnosticsCourseContext.js +76 -0
  19. package/dist/esm/models/GetResourceSessionDiagnosticsResource.d.ts +51 -0
  20. package/dist/esm/models/GetResourceSessionDiagnosticsResource.js +56 -0
  21. package/dist/esm/models/GetResourceSessionDiagnosticsScormSummary.d.ts +74 -0
  22. package/dist/esm/models/GetResourceSessionDiagnosticsScormSummary.js +59 -0
  23. package/dist/esm/models/GetResourceSessionDiagnosticsUser.d.ts +38 -0
  24. package/dist/esm/models/GetResourceSessionDiagnosticsUser.js +47 -0
  25. package/dist/esm/models/GetResourceSessionDiagnosticsVersion.d.ts +88 -0
  26. package/dist/esm/models/GetResourceSessionDiagnosticsVersion.js +67 -0
  27. package/dist/esm/models/GetResourceSessionList.d.ts +57 -0
  28. package/dist/esm/models/GetResourceSessionList.js +60 -0
  29. package/dist/esm/models/GetResourceSessionScormApiLogs.d.ts +57 -0
  30. package/dist/esm/models/GetResourceSessionScormApiLogs.js +60 -0
  31. package/dist/esm/models/GetResourceSessionScormData.d.ts +77 -0
  32. package/dist/esm/models/GetResourceSessionScormData.js +66 -0
  33. package/dist/esm/models/GetResourceSessionScormDataActivity.d.ts +44 -0
  34. package/dist/esm/models/GetResourceSessionScormDataActivity.js +45 -0
  35. package/dist/esm/models/PostResourceVersionSession.d.ts +32 -0
  36. package/dist/esm/models/PostResourceVersionSession.js +41 -0
  37. package/dist/esm/models/ResourceSessionEnvironment.d.ts +25 -0
  38. package/dist/esm/models/ResourceSessionEnvironment.js +43 -0
  39. package/dist/esm/models/ResourceSessionScormApiLogItem.d.ts +79 -0
  40. package/dist/esm/models/ResourceSessionScormApiLogItem.js +73 -0
  41. package/dist/esm/models/index.d.ts +14 -0
  42. package/dist/esm/models/index.js +14 -0
  43. package/dist/models/GetCourseVersionItemSession.d.ts +7 -0
  44. package/dist/models/GetCourseVersionItemSession.js +5 -0
  45. package/dist/models/GetResourceSession.d.ts +191 -0
  46. package/dist/models/GetResourceSession.js +135 -0
  47. package/dist/models/GetResourceSessionDiagnostics.d.ts +76 -0
  48. package/dist/models/GetResourceSessionDiagnostics.js +76 -0
  49. package/dist/models/GetResourceSessionDiagnosticsCourseContext.d.ts +81 -0
  50. package/dist/models/GetResourceSessionDiagnosticsCourseContext.js +83 -0
  51. package/dist/models/GetResourceSessionDiagnosticsResource.d.ts +51 -0
  52. package/dist/models/GetResourceSessionDiagnosticsResource.js +63 -0
  53. package/dist/models/GetResourceSessionDiagnosticsScormSummary.d.ts +74 -0
  54. package/dist/models/GetResourceSessionDiagnosticsScormSummary.js +66 -0
  55. package/dist/models/GetResourceSessionDiagnosticsUser.d.ts +38 -0
  56. package/dist/models/GetResourceSessionDiagnosticsUser.js +54 -0
  57. package/dist/models/GetResourceSessionDiagnosticsVersion.d.ts +88 -0
  58. package/dist/models/GetResourceSessionDiagnosticsVersion.js +74 -0
  59. package/dist/models/GetResourceSessionList.d.ts +57 -0
  60. package/dist/models/GetResourceSessionList.js +67 -0
  61. package/dist/models/GetResourceSessionScormApiLogs.d.ts +57 -0
  62. package/dist/models/GetResourceSessionScormApiLogs.js +67 -0
  63. package/dist/models/GetResourceSessionScormData.d.ts +77 -0
  64. package/dist/models/GetResourceSessionScormData.js +73 -0
  65. package/dist/models/GetResourceSessionScormDataActivity.d.ts +44 -0
  66. package/dist/models/GetResourceSessionScormDataActivity.js +52 -0
  67. package/dist/models/PostResourceVersionSession.d.ts +32 -0
  68. package/dist/models/PostResourceVersionSession.js +48 -0
  69. package/dist/models/ResourceSessionEnvironment.d.ts +25 -0
  70. package/dist/models/ResourceSessionEnvironment.js +51 -0
  71. package/dist/models/ResourceSessionScormApiLogItem.d.ts +79 -0
  72. package/dist/models/ResourceSessionScormApiLogItem.js +81 -0
  73. package/dist/models/index.d.ts +14 -0
  74. package/dist/models/index.js +14 -0
  75. package/docs/ContentLibraryApi.md +73 -0
  76. package/docs/GetCourseVersionItemSession.md +2 -0
  77. package/docs/GetResourceSession.md +87 -0
  78. package/docs/GetResourceSessionDiagnostics.md +47 -0
  79. package/docs/GetResourceSessionDiagnosticsCourseContext.md +50 -0
  80. package/docs/GetResourceSessionDiagnosticsResource.md +40 -0
  81. package/docs/GetResourceSessionDiagnosticsScormSummary.md +48 -0
  82. package/docs/GetResourceSessionDiagnosticsUser.md +36 -0
  83. package/docs/GetResourceSessionDiagnosticsVersion.md +52 -0
  84. package/docs/GetResourceSessionList.md +43 -0
  85. package/docs/GetResourceSessionScormApiLogs.md +43 -0
  86. package/docs/GetResourceSessionScormData.md +49 -0
  87. package/docs/GetResourceSessionScormDataActivity.md +38 -0
  88. package/docs/PlayerApi.md +547 -0
  89. package/docs/PostResourceVersionSession.md +35 -0
  90. package/docs/ResourceSessionEnvironment.md +33 -0
  91. package/docs/ResourceSessionScormApiLogItem.md +47 -0
  92. package/package.json +1 -1
  93. package/src/apis/ContentLibraryApi.ts +72 -0
  94. package/src/apis/PlayerApi.ts +558 -0
  95. package/src/models/GetCourseVersionItemSession.ts +16 -0
  96. package/src/models/GetResourceSession.ts +313 -0
  97. package/src/models/GetResourceSessionDiagnostics.ts +161 -0
  98. package/src/models/GetResourceSessionDiagnosticsCourseContext.ts +148 -0
  99. package/src/models/GetResourceSessionDiagnosticsResource.ts +103 -0
  100. package/src/models/GetResourceSessionDiagnosticsScormSummary.ts +123 -0
  101. package/src/models/GetResourceSessionDiagnosticsUser.ts +75 -0
  102. package/src/models/GetResourceSessionDiagnosticsVersion.ts +141 -0
  103. package/src/models/GetResourceSessionList.ts +110 -0
  104. package/src/models/GetResourceSessionScormApiLogs.ts +110 -0
  105. package/src/models/GetResourceSessionScormData.ts +134 -0
  106. package/src/models/GetResourceSessionScormDataActivity.ts +81 -0
  107. package/src/models/PostResourceVersionSession.ts +65 -0
  108. package/src/models/ResourceSessionEnvironment.ts +53 -0
  109. package/src/models/ResourceSessionScormApiLogItem.ts +132 -0
  110. package/src/models/index.ts +14 -0
@@ -10,6 +10,13 @@
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 GetResourceSessionDiagnostics } from '../models/GetResourceSessionDiagnostics';
15
+ import { type GetResourceSessionList } from '../models/GetResourceSessionList';
16
+ import { type GetResourceSessionScormApiLogs } from '../models/GetResourceSessionScormApiLogs';
17
+ import { type GetResourceSessionScormData } from '../models/GetResourceSessionScormData';
18
+ import { type ResourceSessionEnvironment } from '../models/ResourceSessionEnvironment';
19
+ import { type ResourceType } from '../models/ResourceType';
13
20
  import { type ScormGetValueResponse } from '../models/ScormGetValueResponse';
14
21
  import { type ScormSetValueRequest } from '../models/ScormSetValueRequest';
15
22
  import { type ScormSetValueResponse } from '../models/ScormSetValueResponse';
@@ -46,9 +53,53 @@ export interface GetResourceScormValueRequest {
46
53
  sessionId: string;
47
54
  key: string;
48
55
  }
56
+ export interface GetResourceSessionRequest {
57
+ sessionId: string;
58
+ }
59
+ export interface GetResourceSessionAssetRequest {
60
+ sessionId: string;
61
+ assetPath: string;
62
+ }
63
+ export interface GetResourceSessionDiagnosticsRequest {
64
+ sessionId: string;
65
+ }
66
+ export interface GetResourceSessionListRequest {
67
+ userId?: string;
68
+ resourceId?: string;
69
+ versionId?: string;
70
+ courseId?: string;
71
+ courseVersionId?: string;
72
+ itemId?: string;
73
+ resourceType?: ResourceType;
74
+ environment?: ResourceSessionEnvironment;
75
+ completionStatus?: GetResourceSessionListCompletionStatusEnum;
76
+ gradeStatus?: GetResourceSessionListGradeStatusEnum;
77
+ isCurrent?: boolean;
78
+ attemptNumber?: number;
79
+ createdFrom?: number;
80
+ createdTo?: number;
81
+ updatedFrom?: number;
82
+ updatedTo?: number;
83
+ hasScormErrors?: boolean;
84
+ sortBy?: GetResourceSessionListSortByEnum;
85
+ sortDirection?: GetResourceSessionListSortDirectionEnum;
86
+ page?: number;
87
+ pageSize?: number;
88
+ }
49
89
  export interface GetResourceSessionPlayerRequest {
50
90
  sessionId: string;
51
91
  }
92
+ export interface GetResourceSessionScormApiLogsRequest {
93
+ sessionId: string;
94
+ method?: GetResourceSessionScormApiLogsMethodEnum;
95
+ element?: string;
96
+ errorsOnly?: boolean;
97
+ page?: number;
98
+ pageSize?: number;
99
+ }
100
+ export interface GetResourceSessionScormDataRequest {
101
+ sessionId: string;
102
+ }
52
103
  export interface GetScormAssetRequest {
53
104
  contentId: string;
54
105
  assetPath: string;
@@ -65,6 +116,9 @@ export interface GetVideoPlayerRequest {
65
116
  export interface InitializeResourceScormSessionRequest {
66
117
  sessionId: string;
67
118
  }
119
+ export interface PostResourceSessionCompleteRequest {
120
+ sessionId: string;
121
+ }
68
122
  export interface SetResourceScormValueRequest {
69
123
  sessionId: string;
70
124
  scormSetValueRequest: ScormSetValueRequest;
@@ -196,6 +250,54 @@ export declare class PlayerApi extends runtime.BaseAPI {
196
250
  * Read a CMI value from a reusable SCORM resource session
197
251
  */
198
252
  getResourceScormValue(requestParameters: GetResourceScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScormGetValueResponse>;
253
+ /**
254
+ * Creates request options for getResourceSession without sending the request
255
+ */
256
+ getResourceSessionRequestOpts(requestParameters: GetResourceSessionRequest): Promise<runtime.RequestOpts>;
257
+ /**
258
+ * Get a resource session
259
+ */
260
+ getResourceSessionRaw(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>>;
261
+ /**
262
+ * Get a resource session
263
+ */
264
+ getResourceSession(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
265
+ /**
266
+ * Creates request options for getResourceSessionAsset without sending the request
267
+ */
268
+ getResourceSessionAssetRequestOpts(requestParameters: GetResourceSessionAssetRequest): Promise<runtime.RequestOpts>;
269
+ /**
270
+ * Stream an asset pinned to a resource session
271
+ */
272
+ getResourceSessionAssetRaw(requestParameters: GetResourceSessionAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
273
+ /**
274
+ * Stream an asset pinned to a resource session
275
+ */
276
+ getResourceSessionAsset(requestParameters: GetResourceSessionAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
277
+ /**
278
+ * Creates request options for getResourceSessionDiagnostics without sending the request
279
+ */
280
+ getResourceSessionDiagnosticsRequestOpts(requestParameters: GetResourceSessionDiagnosticsRequest): Promise<runtime.RequestOpts>;
281
+ /**
282
+ * Get administrator diagnostics for a resource session
283
+ */
284
+ getResourceSessionDiagnosticsRaw(requestParameters: GetResourceSessionDiagnosticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionDiagnostics>>;
285
+ /**
286
+ * Get administrator diagnostics for a resource session
287
+ */
288
+ getResourceSessionDiagnostics(requestParameters: GetResourceSessionDiagnosticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionDiagnostics>;
289
+ /**
290
+ * Creates request options for getResourceSessionList without sending the request
291
+ */
292
+ getResourceSessionListRequestOpts(requestParameters: GetResourceSessionListRequest): Promise<runtime.RequestOpts>;
293
+ /**
294
+ * List resource sessions for the selected portal
295
+ */
296
+ getResourceSessionListRaw(requestParameters: GetResourceSessionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionList>>;
297
+ /**
298
+ * List resource sessions for the selected portal
299
+ */
300
+ getResourceSessionList(requestParameters?: GetResourceSessionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionList>;
199
301
  /**
200
302
  * Creates request options for getResourceSessionPlayer without sending the request
201
303
  */
@@ -208,6 +310,30 @@ export declare class PlayerApi extends runtime.BaseAPI {
208
310
  * Serve the player for a version-pinned reusable resource session
209
311
  */
210
312
  getResourceSessionPlayer(requestParameters: GetResourceSessionPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
313
+ /**
314
+ * Creates request options for getResourceSessionScormApiLogs without sending the request
315
+ */
316
+ getResourceSessionScormApiLogsRequestOpts(requestParameters: GetResourceSessionScormApiLogsRequest): Promise<runtime.RequestOpts>;
317
+ /**
318
+ * Get SCORM runtime logs for a resource session
319
+ */
320
+ getResourceSessionScormApiLogsRaw(requestParameters: GetResourceSessionScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionScormApiLogs>>;
321
+ /**
322
+ * Get SCORM runtime logs for a resource session
323
+ */
324
+ getResourceSessionScormApiLogs(requestParameters: GetResourceSessionScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionScormApiLogs>;
325
+ /**
326
+ * Creates request options for getResourceSessionScormData without sending the request
327
+ */
328
+ getResourceSessionScormDataRequestOpts(requestParameters: GetResourceSessionScormDataRequest): Promise<runtime.RequestOpts>;
329
+ /**
330
+ * Get SCORM CMI data for a resource session
331
+ */
332
+ getResourceSessionScormDataRaw(requestParameters: GetResourceSessionScormDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionScormData>>;
333
+ /**
334
+ * Get SCORM CMI data for a resource session
335
+ */
336
+ getResourceSessionScormData(requestParameters: GetResourceSessionScormDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionScormData>;
211
337
  /**
212
338
  * Creates request options for getScormAsset without sending the request
213
339
  */
@@ -268,6 +394,18 @@ export declare class PlayerApi extends runtime.BaseAPI {
268
394
  * Initialize a reusable SCORM resource session
269
395
  */
270
396
  initializeResourceScormSession(requestParameters: InitializeResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
397
+ /**
398
+ * Creates request options for postResourceSessionComplete without sending the request
399
+ */
400
+ postResourceSessionCompleteRequestOpts(requestParameters: PostResourceSessionCompleteRequest): Promise<runtime.RequestOpts>;
401
+ /**
402
+ * Complete a non-SCORM resource session
403
+ */
404
+ postResourceSessionCompleteRaw(requestParameters: PostResourceSessionCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>>;
405
+ /**
406
+ * Complete a non-SCORM resource session
407
+ */
408
+ postResourceSessionComplete(requestParameters: PostResourceSessionCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
271
409
  /**
272
410
  * Creates request options for setResourceScormValue without sending the request
273
411
  */
@@ -293,3 +431,52 @@ export declare class PlayerApi extends runtime.BaseAPI {
293
431
  */
294
432
  terminateResourceScormSession(requestParameters: TerminateResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
295
433
  }
434
+ /**
435
+ * @export
436
+ */
437
+ export declare const GetResourceSessionListCompletionStatusEnum: {
438
+ readonly NotAttempted: "not_attempted";
439
+ readonly InProgress: "in_progress";
440
+ readonly Completed: "completed";
441
+ };
442
+ export type GetResourceSessionListCompletionStatusEnum = typeof GetResourceSessionListCompletionStatusEnum[keyof typeof GetResourceSessionListCompletionStatusEnum];
443
+ /**
444
+ * @export
445
+ */
446
+ export declare const GetResourceSessionListGradeStatusEnum: {
447
+ readonly Ungraded: "ungraded";
448
+ readonly Passed: "passed";
449
+ readonly Failed: "failed";
450
+ readonly PointsEarned: "points_earned";
451
+ readonly PercentageEarned: "percentage_earned";
452
+ readonly NotApplicable: "not_applicable";
453
+ };
454
+ export type GetResourceSessionListGradeStatusEnum = typeof GetResourceSessionListGradeStatusEnum[keyof typeof GetResourceSessionListGradeStatusEnum];
455
+ /**
456
+ * @export
457
+ */
458
+ export declare const GetResourceSessionListSortByEnum: {
459
+ readonly CreatedAt: "created_at";
460
+ readonly UpdatedAt: "updated_at";
461
+ readonly AttemptNumber: "attempt_number";
462
+ };
463
+ export type GetResourceSessionListSortByEnum = typeof GetResourceSessionListSortByEnum[keyof typeof GetResourceSessionListSortByEnum];
464
+ /**
465
+ * @export
466
+ */
467
+ export declare const GetResourceSessionListSortDirectionEnum: {
468
+ readonly Asc: "asc";
469
+ readonly Desc: "desc";
470
+ };
471
+ export type GetResourceSessionListSortDirectionEnum = typeof GetResourceSessionListSortDirectionEnum[keyof typeof GetResourceSessionListSortDirectionEnum];
472
+ /**
473
+ * @export
474
+ */
475
+ export declare const GetResourceSessionScormApiLogsMethodEnum: {
476
+ readonly Initialize: "Initialize";
477
+ readonly GetValue: "GetValue";
478
+ readonly SetValue: "SetValue";
479
+ readonly Commit: "Commit";
480
+ readonly Terminate: "Terminate";
481
+ };
482
+ export type GetResourceSessionScormApiLogsMethodEnum = typeof GetResourceSessionScormApiLogsMethodEnum[keyof typeof GetResourceSessionScormApiLogsMethodEnum];
@@ -21,6 +21,11 @@ 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 { GetResourceSessionDiagnosticsFromJSON, } from '../models/GetResourceSessionDiagnostics';
26
+ import { GetResourceSessionListFromJSON, } from '../models/GetResourceSessionList';
27
+ import { GetResourceSessionScormApiLogsFromJSON, } from '../models/GetResourceSessionScormApiLogs';
28
+ import { GetResourceSessionScormDataFromJSON, } from '../models/GetResourceSessionScormData';
24
29
  import { ScormGetValueResponseFromJSON, } from '../models/ScormGetValueResponse';
25
30
  import { ScormSetValueRequestToJSON, } from '../models/ScormSetValueRequest';
26
31
  import { ScormSetValueResponseFromJSON, } from '../models/ScormSetValueResponse';
@@ -424,6 +429,225 @@ export class PlayerApi extends runtime.BaseAPI {
424
429
  return yield response.value();
425
430
  });
426
431
  }
432
+ /**
433
+ * Creates request options for getResourceSession without sending the request
434
+ */
435
+ getResourceSessionRequestOpts(requestParameters) {
436
+ return __awaiter(this, void 0, void 0, function* () {
437
+ if (requestParameters['sessionId'] == null) {
438
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSession().');
439
+ }
440
+ const queryParameters = {};
441
+ const headerParameters = {};
442
+ let urlPath = `/resource/sessions/{sessionId}`;
443
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
444
+ return {
445
+ path: urlPath,
446
+ method: 'GET',
447
+ headers: headerParameters,
448
+ query: queryParameters,
449
+ };
450
+ });
451
+ }
452
+ /**
453
+ * Get a resource session
454
+ */
455
+ getResourceSessionRaw(requestParameters, initOverrides) {
456
+ return __awaiter(this, void 0, void 0, function* () {
457
+ const requestOptions = yield this.getResourceSessionRequestOpts(requestParameters);
458
+ const response = yield this.request(requestOptions, initOverrides);
459
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionFromJSON(jsonValue));
460
+ });
461
+ }
462
+ /**
463
+ * Get a resource session
464
+ */
465
+ getResourceSession(requestParameters, initOverrides) {
466
+ return __awaiter(this, void 0, void 0, function* () {
467
+ const response = yield this.getResourceSessionRaw(requestParameters, initOverrides);
468
+ return yield response.value();
469
+ });
470
+ }
471
+ /**
472
+ * Creates request options for getResourceSessionAsset without sending the request
473
+ */
474
+ getResourceSessionAssetRequestOpts(requestParameters) {
475
+ return __awaiter(this, void 0, void 0, function* () {
476
+ if (requestParameters['sessionId'] == null) {
477
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionAsset().');
478
+ }
479
+ if (requestParameters['assetPath'] == null) {
480
+ throw new runtime.RequiredError('assetPath', 'Required parameter "assetPath" was null or undefined when calling getResourceSessionAsset().');
481
+ }
482
+ const queryParameters = {};
483
+ const headerParameters = {};
484
+ let urlPath = `/resource/sessions/{sessionId}/asset/{assetPath}`;
485
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
486
+ urlPath = urlPath.replace('{assetPath}', encodeURIComponent(String(requestParameters['assetPath'])));
487
+ return {
488
+ path: urlPath,
489
+ method: 'GET',
490
+ headers: headerParameters,
491
+ query: queryParameters,
492
+ };
493
+ });
494
+ }
495
+ /**
496
+ * Stream an asset pinned to a resource session
497
+ */
498
+ getResourceSessionAssetRaw(requestParameters, initOverrides) {
499
+ return __awaiter(this, void 0, void 0, function* () {
500
+ const requestOptions = yield this.getResourceSessionAssetRequestOpts(requestParameters);
501
+ const response = yield this.request(requestOptions, initOverrides);
502
+ return new runtime.BlobApiResponse(response);
503
+ });
504
+ }
505
+ /**
506
+ * Stream an asset pinned to a resource session
507
+ */
508
+ getResourceSessionAsset(requestParameters, initOverrides) {
509
+ return __awaiter(this, void 0, void 0, function* () {
510
+ const response = yield this.getResourceSessionAssetRaw(requestParameters, initOverrides);
511
+ return yield response.value();
512
+ });
513
+ }
514
+ /**
515
+ * Creates request options for getResourceSessionDiagnostics without sending the request
516
+ */
517
+ getResourceSessionDiagnosticsRequestOpts(requestParameters) {
518
+ return __awaiter(this, void 0, void 0, function* () {
519
+ if (requestParameters['sessionId'] == null) {
520
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionDiagnostics().');
521
+ }
522
+ const queryParameters = {};
523
+ const headerParameters = {};
524
+ let urlPath = `/resource/sessions/{sessionId}/diagnostics`;
525
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
526
+ return {
527
+ path: urlPath,
528
+ method: 'GET',
529
+ headers: headerParameters,
530
+ query: queryParameters,
531
+ };
532
+ });
533
+ }
534
+ /**
535
+ * Get administrator diagnostics for a resource session
536
+ */
537
+ getResourceSessionDiagnosticsRaw(requestParameters, initOverrides) {
538
+ return __awaiter(this, void 0, void 0, function* () {
539
+ const requestOptions = yield this.getResourceSessionDiagnosticsRequestOpts(requestParameters);
540
+ const response = yield this.request(requestOptions, initOverrides);
541
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionDiagnosticsFromJSON(jsonValue));
542
+ });
543
+ }
544
+ /**
545
+ * Get administrator diagnostics for a resource session
546
+ */
547
+ getResourceSessionDiagnostics(requestParameters, initOverrides) {
548
+ return __awaiter(this, void 0, void 0, function* () {
549
+ const response = yield this.getResourceSessionDiagnosticsRaw(requestParameters, initOverrides);
550
+ return yield response.value();
551
+ });
552
+ }
553
+ /**
554
+ * Creates request options for getResourceSessionList without sending the request
555
+ */
556
+ getResourceSessionListRequestOpts(requestParameters) {
557
+ return __awaiter(this, void 0, void 0, function* () {
558
+ const queryParameters = {};
559
+ if (requestParameters['userId'] != null) {
560
+ queryParameters['user_id'] = requestParameters['userId'];
561
+ }
562
+ if (requestParameters['resourceId'] != null) {
563
+ queryParameters['resource_id'] = requestParameters['resourceId'];
564
+ }
565
+ if (requestParameters['versionId'] != null) {
566
+ queryParameters['version_id'] = requestParameters['versionId'];
567
+ }
568
+ if (requestParameters['courseId'] != null) {
569
+ queryParameters['course_id'] = requestParameters['courseId'];
570
+ }
571
+ if (requestParameters['courseVersionId'] != null) {
572
+ queryParameters['course_version_id'] = requestParameters['courseVersionId'];
573
+ }
574
+ if (requestParameters['itemId'] != null) {
575
+ queryParameters['item_id'] = requestParameters['itemId'];
576
+ }
577
+ if (requestParameters['resourceType'] != null) {
578
+ queryParameters['resource_type'] = requestParameters['resourceType'];
579
+ }
580
+ if (requestParameters['environment'] != null) {
581
+ queryParameters['environment'] = requestParameters['environment'];
582
+ }
583
+ if (requestParameters['completionStatus'] != null) {
584
+ queryParameters['completion_status'] = requestParameters['completionStatus'];
585
+ }
586
+ if (requestParameters['gradeStatus'] != null) {
587
+ queryParameters['grade_status'] = requestParameters['gradeStatus'];
588
+ }
589
+ if (requestParameters['isCurrent'] != null) {
590
+ queryParameters['is_current'] = requestParameters['isCurrent'];
591
+ }
592
+ if (requestParameters['attemptNumber'] != null) {
593
+ queryParameters['attempt_number'] = requestParameters['attemptNumber'];
594
+ }
595
+ if (requestParameters['createdFrom'] != null) {
596
+ queryParameters['created_from'] = requestParameters['createdFrom'];
597
+ }
598
+ if (requestParameters['createdTo'] != null) {
599
+ queryParameters['created_to'] = requestParameters['createdTo'];
600
+ }
601
+ if (requestParameters['updatedFrom'] != null) {
602
+ queryParameters['updated_from'] = requestParameters['updatedFrom'];
603
+ }
604
+ if (requestParameters['updatedTo'] != null) {
605
+ queryParameters['updated_to'] = requestParameters['updatedTo'];
606
+ }
607
+ if (requestParameters['hasScormErrors'] != null) {
608
+ queryParameters['has_scorm_errors'] = requestParameters['hasScormErrors'];
609
+ }
610
+ if (requestParameters['sortBy'] != null) {
611
+ queryParameters['sort_by'] = requestParameters['sortBy'];
612
+ }
613
+ if (requestParameters['sortDirection'] != null) {
614
+ queryParameters['sort_direction'] = requestParameters['sortDirection'];
615
+ }
616
+ if (requestParameters['page'] != null) {
617
+ queryParameters['page'] = requestParameters['page'];
618
+ }
619
+ if (requestParameters['pageSize'] != null) {
620
+ queryParameters['pageSize'] = requestParameters['pageSize'];
621
+ }
622
+ const headerParameters = {};
623
+ let urlPath = `/resource/sessions`;
624
+ return {
625
+ path: urlPath,
626
+ method: 'GET',
627
+ headers: headerParameters,
628
+ query: queryParameters,
629
+ };
630
+ });
631
+ }
632
+ /**
633
+ * List resource sessions for the selected portal
634
+ */
635
+ getResourceSessionListRaw(requestParameters, initOverrides) {
636
+ return __awaiter(this, void 0, void 0, function* () {
637
+ const requestOptions = yield this.getResourceSessionListRequestOpts(requestParameters);
638
+ const response = yield this.request(requestOptions, initOverrides);
639
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionListFromJSON(jsonValue));
640
+ });
641
+ }
642
+ /**
643
+ * List resource sessions for the selected portal
644
+ */
645
+ getResourceSessionList() {
646
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
647
+ const response = yield this.getResourceSessionListRaw(requestParameters, initOverrides);
648
+ return yield response.value();
649
+ });
650
+ }
427
651
  /**
428
652
  * Creates request options for getResourceSessionPlayer without sending the request
429
653
  */
@@ -468,6 +692,99 @@ export class PlayerApi extends runtime.BaseAPI {
468
692
  return yield response.value();
469
693
  });
470
694
  }
695
+ /**
696
+ * Creates request options for getResourceSessionScormApiLogs without sending the request
697
+ */
698
+ getResourceSessionScormApiLogsRequestOpts(requestParameters) {
699
+ return __awaiter(this, void 0, void 0, function* () {
700
+ if (requestParameters['sessionId'] == null) {
701
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionScormApiLogs().');
702
+ }
703
+ const queryParameters = {};
704
+ if (requestParameters['method'] != null) {
705
+ queryParameters['method'] = requestParameters['method'];
706
+ }
707
+ if (requestParameters['element'] != null) {
708
+ queryParameters['element'] = requestParameters['element'];
709
+ }
710
+ if (requestParameters['errorsOnly'] != null) {
711
+ queryParameters['errors_only'] = requestParameters['errorsOnly'];
712
+ }
713
+ if (requestParameters['page'] != null) {
714
+ queryParameters['page'] = requestParameters['page'];
715
+ }
716
+ if (requestParameters['pageSize'] != null) {
717
+ queryParameters['pageSize'] = requestParameters['pageSize'];
718
+ }
719
+ const headerParameters = {};
720
+ let urlPath = `/resource/sessions/{sessionId}/api-logs`;
721
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
722
+ return {
723
+ path: urlPath,
724
+ method: 'GET',
725
+ headers: headerParameters,
726
+ query: queryParameters,
727
+ };
728
+ });
729
+ }
730
+ /**
731
+ * Get SCORM runtime logs for a resource session
732
+ */
733
+ getResourceSessionScormApiLogsRaw(requestParameters, initOverrides) {
734
+ return __awaiter(this, void 0, void 0, function* () {
735
+ const requestOptions = yield this.getResourceSessionScormApiLogsRequestOpts(requestParameters);
736
+ const response = yield this.request(requestOptions, initOverrides);
737
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionScormApiLogsFromJSON(jsonValue));
738
+ });
739
+ }
740
+ /**
741
+ * Get SCORM runtime logs for a resource session
742
+ */
743
+ getResourceSessionScormApiLogs(requestParameters, initOverrides) {
744
+ return __awaiter(this, void 0, void 0, function* () {
745
+ const response = yield this.getResourceSessionScormApiLogsRaw(requestParameters, initOverrides);
746
+ return yield response.value();
747
+ });
748
+ }
749
+ /**
750
+ * Creates request options for getResourceSessionScormData without sending the request
751
+ */
752
+ getResourceSessionScormDataRequestOpts(requestParameters) {
753
+ return __awaiter(this, void 0, void 0, function* () {
754
+ if (requestParameters['sessionId'] == null) {
755
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionScormData().');
756
+ }
757
+ const queryParameters = {};
758
+ const headerParameters = {};
759
+ let urlPath = `/resource/sessions/{sessionId}/scorm-data`;
760
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
761
+ return {
762
+ path: urlPath,
763
+ method: 'GET',
764
+ headers: headerParameters,
765
+ query: queryParameters,
766
+ };
767
+ });
768
+ }
769
+ /**
770
+ * Get SCORM CMI data for a resource session
771
+ */
772
+ getResourceSessionScormDataRaw(requestParameters, initOverrides) {
773
+ return __awaiter(this, void 0, void 0, function* () {
774
+ const requestOptions = yield this.getResourceSessionScormDataRequestOpts(requestParameters);
775
+ const response = yield this.request(requestOptions, initOverrides);
776
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionScormDataFromJSON(jsonValue));
777
+ });
778
+ }
779
+ /**
780
+ * Get SCORM CMI data for a resource session
781
+ */
782
+ getResourceSessionScormData(requestParameters, initOverrides) {
783
+ return __awaiter(this, void 0, void 0, function* () {
784
+ const response = yield this.getResourceSessionScormDataRaw(requestParameters, initOverrides);
785
+ return yield response.value();
786
+ });
787
+ }
471
788
  /**
472
789
  * Creates request options for getScormAsset without sending the request
473
790
  */
@@ -662,6 +979,45 @@ export class PlayerApi extends runtime.BaseAPI {
662
979
  yield this.initializeResourceScormSessionRaw(requestParameters, initOverrides);
663
980
  });
664
981
  }
982
+ /**
983
+ * Creates request options for postResourceSessionComplete without sending the request
984
+ */
985
+ postResourceSessionCompleteRequestOpts(requestParameters) {
986
+ return __awaiter(this, void 0, void 0, function* () {
987
+ if (requestParameters['sessionId'] == null) {
988
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling postResourceSessionComplete().');
989
+ }
990
+ const queryParameters = {};
991
+ const headerParameters = {};
992
+ let urlPath = `/resource/sessions/{sessionId}/complete`;
993
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
994
+ return {
995
+ path: urlPath,
996
+ method: 'POST',
997
+ headers: headerParameters,
998
+ query: queryParameters,
999
+ };
1000
+ });
1001
+ }
1002
+ /**
1003
+ * Complete a non-SCORM resource session
1004
+ */
1005
+ postResourceSessionCompleteRaw(requestParameters, initOverrides) {
1006
+ return __awaiter(this, void 0, void 0, function* () {
1007
+ const requestOptions = yield this.postResourceSessionCompleteRequestOpts(requestParameters);
1008
+ const response = yield this.request(requestOptions, initOverrides);
1009
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionFromJSON(jsonValue));
1010
+ });
1011
+ }
1012
+ /**
1013
+ * Complete a non-SCORM resource session
1014
+ */
1015
+ postResourceSessionComplete(requestParameters, initOverrides) {
1016
+ return __awaiter(this, void 0, void 0, function* () {
1017
+ const response = yield this.postResourceSessionCompleteRaw(requestParameters, initOverrides);
1018
+ return yield response.value();
1019
+ });
1020
+ }
665
1021
  /**
666
1022
  * Creates request options for setResourceScormValue without sending the request
667
1023
  */
@@ -745,3 +1101,47 @@ export class PlayerApi extends runtime.BaseAPI {
745
1101
  });
746
1102
  }
747
1103
  }
1104
+ /**
1105
+ * @export
1106
+ */
1107
+ export const GetResourceSessionListCompletionStatusEnum = {
1108
+ NotAttempted: 'not_attempted',
1109
+ InProgress: 'in_progress',
1110
+ Completed: 'completed'
1111
+ };
1112
+ /**
1113
+ * @export
1114
+ */
1115
+ export const GetResourceSessionListGradeStatusEnum = {
1116
+ Ungraded: 'ungraded',
1117
+ Passed: 'passed',
1118
+ Failed: 'failed',
1119
+ PointsEarned: 'points_earned',
1120
+ PercentageEarned: 'percentage_earned',
1121
+ NotApplicable: 'not_applicable'
1122
+ };
1123
+ /**
1124
+ * @export
1125
+ */
1126
+ export const GetResourceSessionListSortByEnum = {
1127
+ CreatedAt: 'created_at',
1128
+ UpdatedAt: 'updated_at',
1129
+ AttemptNumber: 'attempt_number'
1130
+ };
1131
+ /**
1132
+ * @export
1133
+ */
1134
+ export const GetResourceSessionListSortDirectionEnum = {
1135
+ Asc: 'asc',
1136
+ Desc: 'desc'
1137
+ };
1138
+ /**
1139
+ * @export
1140
+ */
1141
+ export const GetResourceSessionScormApiLogsMethodEnum = {
1142
+ Initialize: 'Initialize',
1143
+ GetValue: 'GetValue',
1144
+ SetValue: 'SetValue',
1145
+ Commit: 'Commit',
1146
+ Terminate: 'Terminate'
1147
+ };
@@ -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}