@easyedu/js-lsm-api 1.90.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 (80) hide show
  1. package/.openapi-generator/FILES +20 -0
  2. package/README.md +15 -2
  3. package/dist/apis/PlayerApi.d.ts +115 -1
  4. package/dist/apis/PlayerApi.js +213 -1
  5. package/dist/esm/apis/PlayerApi.d.ts +115 -1
  6. package/dist/esm/apis/PlayerApi.js +212 -0
  7. package/dist/esm/models/GetResourceSession.d.ts +30 -0
  8. package/dist/esm/models/GetResourceSession.js +16 -0
  9. package/dist/esm/models/GetResourceSessionDiagnostics.d.ts +76 -0
  10. package/dist/esm/models/GetResourceSessionDiagnostics.js +69 -0
  11. package/dist/esm/models/GetResourceSessionDiagnosticsCourseContext.d.ts +81 -0
  12. package/dist/esm/models/GetResourceSessionDiagnosticsCourseContext.js +76 -0
  13. package/dist/esm/models/GetResourceSessionDiagnosticsResource.d.ts +51 -0
  14. package/dist/esm/models/GetResourceSessionDiagnosticsResource.js +56 -0
  15. package/dist/esm/models/GetResourceSessionDiagnosticsScormSummary.d.ts +74 -0
  16. package/dist/esm/models/GetResourceSessionDiagnosticsScormSummary.js +59 -0
  17. package/dist/esm/models/GetResourceSessionDiagnosticsUser.d.ts +38 -0
  18. package/dist/esm/models/GetResourceSessionDiagnosticsUser.js +47 -0
  19. package/dist/esm/models/GetResourceSessionDiagnosticsVersion.d.ts +88 -0
  20. package/dist/esm/models/GetResourceSessionDiagnosticsVersion.js +67 -0
  21. package/dist/esm/models/GetResourceSessionScormApiLogs.d.ts +57 -0
  22. package/dist/esm/models/GetResourceSessionScormApiLogs.js +60 -0
  23. package/dist/esm/models/GetResourceSessionScormData.d.ts +77 -0
  24. package/dist/esm/models/GetResourceSessionScormData.js +66 -0
  25. package/dist/esm/models/GetResourceSessionScormDataActivity.d.ts +44 -0
  26. package/dist/esm/models/GetResourceSessionScormDataActivity.js +45 -0
  27. package/dist/esm/models/ResourceSessionScormApiLogItem.d.ts +79 -0
  28. package/dist/esm/models/ResourceSessionScormApiLogItem.js +73 -0
  29. package/dist/esm/models/index.d.ts +10 -0
  30. package/dist/esm/models/index.js +10 -0
  31. package/dist/models/GetResourceSession.d.ts +30 -0
  32. package/dist/models/GetResourceSession.js +16 -0
  33. package/dist/models/GetResourceSessionDiagnostics.d.ts +76 -0
  34. package/dist/models/GetResourceSessionDiagnostics.js +76 -0
  35. package/dist/models/GetResourceSessionDiagnosticsCourseContext.d.ts +81 -0
  36. package/dist/models/GetResourceSessionDiagnosticsCourseContext.js +83 -0
  37. package/dist/models/GetResourceSessionDiagnosticsResource.d.ts +51 -0
  38. package/dist/models/GetResourceSessionDiagnosticsResource.js +63 -0
  39. package/dist/models/GetResourceSessionDiagnosticsScormSummary.d.ts +74 -0
  40. package/dist/models/GetResourceSessionDiagnosticsScormSummary.js +66 -0
  41. package/dist/models/GetResourceSessionDiagnosticsUser.d.ts +38 -0
  42. package/dist/models/GetResourceSessionDiagnosticsUser.js +54 -0
  43. package/dist/models/GetResourceSessionDiagnosticsVersion.d.ts +88 -0
  44. package/dist/models/GetResourceSessionDiagnosticsVersion.js +74 -0
  45. package/dist/models/GetResourceSessionScormApiLogs.d.ts +57 -0
  46. package/dist/models/GetResourceSessionScormApiLogs.js +67 -0
  47. package/dist/models/GetResourceSessionScormData.d.ts +77 -0
  48. package/dist/models/GetResourceSessionScormData.js +73 -0
  49. package/dist/models/GetResourceSessionScormDataActivity.d.ts +44 -0
  50. package/dist/models/GetResourceSessionScormDataActivity.js +52 -0
  51. package/dist/models/ResourceSessionScormApiLogItem.d.ts +79 -0
  52. package/dist/models/ResourceSessionScormApiLogItem.js +81 -0
  53. package/dist/models/index.d.ts +10 -0
  54. package/dist/models/index.js +10 -0
  55. package/docs/GetResourceSession.md +10 -0
  56. package/docs/GetResourceSessionDiagnostics.md +47 -0
  57. package/docs/GetResourceSessionDiagnosticsCourseContext.md +50 -0
  58. package/docs/GetResourceSessionDiagnosticsResource.md +40 -0
  59. package/docs/GetResourceSessionDiagnosticsScormSummary.md +48 -0
  60. package/docs/GetResourceSessionDiagnosticsUser.md +36 -0
  61. package/docs/GetResourceSessionDiagnosticsVersion.md +52 -0
  62. package/docs/GetResourceSessionScormApiLogs.md +43 -0
  63. package/docs/GetResourceSessionScormData.md +49 -0
  64. package/docs/GetResourceSessionScormDataActivity.md +38 -0
  65. package/docs/PlayerApi.md +254 -3
  66. package/docs/ResourceSessionScormApiLogItem.md +47 -0
  67. package/package.json +1 -1
  68. package/src/apis/PlayerApi.ts +298 -1
  69. package/src/models/GetResourceSession.ts +43 -0
  70. package/src/models/GetResourceSessionDiagnostics.ts +161 -0
  71. package/src/models/GetResourceSessionDiagnosticsCourseContext.ts +148 -0
  72. package/src/models/GetResourceSessionDiagnosticsResource.ts +103 -0
  73. package/src/models/GetResourceSessionDiagnosticsScormSummary.ts +123 -0
  74. package/src/models/GetResourceSessionDiagnosticsUser.ts +75 -0
  75. package/src/models/GetResourceSessionDiagnosticsVersion.ts +141 -0
  76. package/src/models/GetResourceSessionScormApiLogs.ts +110 -0
  77. package/src/models/GetResourceSessionScormData.ts +134 -0
  78. package/src/models/GetResourceSessionScormDataActivity.ts +81 -0
  79. package/src/models/ResourceSessionScormApiLogItem.ts +132 -0
  80. package/src/models/index.ts +10 -0
@@ -11,8 +11,12 @@
11
11
  */
12
12
  import * as runtime from '../runtime';
13
13
  import { type GetResourceSession } from '../models/GetResourceSession';
14
+ import { type GetResourceSessionDiagnostics } from '../models/GetResourceSessionDiagnostics';
14
15
  import { type GetResourceSessionList } from '../models/GetResourceSessionList';
16
+ import { type GetResourceSessionScormApiLogs } from '../models/GetResourceSessionScormApiLogs';
17
+ import { type GetResourceSessionScormData } from '../models/GetResourceSessionScormData';
15
18
  import { type ResourceSessionEnvironment } from '../models/ResourceSessionEnvironment';
19
+ import { type ResourceType } from '../models/ResourceType';
16
20
  import { type ScormGetValueResponse } from '../models/ScormGetValueResponse';
17
21
  import { type ScormSetValueRequest } from '../models/ScormSetValueRequest';
18
22
  import { type ScormSetValueResponse } from '../models/ScormSetValueResponse';
@@ -56,21 +60,46 @@ export interface GetResourceSessionAssetRequest {
56
60
  sessionId: string;
57
61
  assetPath: string;
58
62
  }
63
+ export interface GetResourceSessionDiagnosticsRequest {
64
+ sessionId: string;
65
+ }
59
66
  export interface GetResourceSessionListRequest {
60
67
  userId?: string;
61
68
  resourceId?: string;
62
69
  versionId?: string;
63
70
  courseId?: string;
71
+ courseVersionId?: string;
72
+ itemId?: string;
73
+ resourceType?: ResourceType;
64
74
  environment?: ResourceSessionEnvironment;
65
- completionStatus?: string;
75
+ completionStatus?: GetResourceSessionListCompletionStatusEnum;
76
+ gradeStatus?: GetResourceSessionListGradeStatusEnum;
77
+ isCurrent?: boolean;
78
+ attemptNumber?: number;
66
79
  createdFrom?: number;
67
80
  createdTo?: number;
81
+ updatedFrom?: number;
82
+ updatedTo?: number;
83
+ hasScormErrors?: boolean;
84
+ sortBy?: GetResourceSessionListSortByEnum;
85
+ sortDirection?: GetResourceSessionListSortDirectionEnum;
68
86
  page?: number;
69
87
  pageSize?: number;
70
88
  }
71
89
  export interface GetResourceSessionPlayerRequest {
72
90
  sessionId: string;
73
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
+ }
74
103
  export interface GetScormAssetRequest {
75
104
  contentId: string;
76
105
  assetPath: string;
@@ -245,6 +274,18 @@ export declare class PlayerApi extends runtime.BaseAPI {
245
274
  * Stream an asset pinned to a resource session
246
275
  */
247
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>;
248
289
  /**
249
290
  * Creates request options for getResourceSessionList without sending the request
250
291
  */
@@ -269,6 +310,30 @@ export declare class PlayerApi extends runtime.BaseAPI {
269
310
  * Serve the player for a version-pinned reusable resource session
270
311
  */
271
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>;
272
337
  /**
273
338
  * Creates request options for getScormAsset without sending the request
274
339
  */
@@ -366,3 +431,52 @@ export declare class PlayerApi extends runtime.BaseAPI {
366
431
  */
367
432
  terminateResourceScormSession(requestParameters: TerminateResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
368
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];
@@ -22,7 +22,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  };
23
23
  import * as runtime from '../runtime';
24
24
  import { GetResourceSessionFromJSON, } from '../models/GetResourceSession';
25
+ import { GetResourceSessionDiagnosticsFromJSON, } from '../models/GetResourceSessionDiagnostics';
25
26
  import { GetResourceSessionListFromJSON, } from '../models/GetResourceSessionList';
27
+ import { GetResourceSessionScormApiLogsFromJSON, } from '../models/GetResourceSessionScormApiLogs';
28
+ import { GetResourceSessionScormDataFromJSON, } from '../models/GetResourceSessionScormData';
26
29
  import { ScormGetValueResponseFromJSON, } from '../models/ScormGetValueResponse';
27
30
  import { ScormSetValueRequestToJSON, } from '../models/ScormSetValueRequest';
28
31
  import { ScormSetValueResponseFromJSON, } from '../models/ScormSetValueResponse';
@@ -508,6 +511,45 @@ export class PlayerApi extends runtime.BaseAPI {
508
511
  return yield response.value();
509
512
  });
510
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
+ }
511
553
  /**
512
554
  * Creates request options for getResourceSessionList without sending the request
513
555
  */
@@ -526,18 +568,51 @@ export class PlayerApi extends runtime.BaseAPI {
526
568
  if (requestParameters['courseId'] != null) {
527
569
  queryParameters['course_id'] = requestParameters['courseId'];
528
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
+ }
529
580
  if (requestParameters['environment'] != null) {
530
581
  queryParameters['environment'] = requestParameters['environment'];
531
582
  }
532
583
  if (requestParameters['completionStatus'] != null) {
533
584
  queryParameters['completion_status'] = requestParameters['completionStatus'];
534
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
+ }
535
595
  if (requestParameters['createdFrom'] != null) {
536
596
  queryParameters['created_from'] = requestParameters['createdFrom'];
537
597
  }
538
598
  if (requestParameters['createdTo'] != null) {
539
599
  queryParameters['created_to'] = requestParameters['createdTo'];
540
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
+ }
541
616
  if (requestParameters['page'] != null) {
542
617
  queryParameters['page'] = requestParameters['page'];
543
618
  }
@@ -617,6 +692,99 @@ export class PlayerApi extends runtime.BaseAPI {
617
692
  return yield response.value();
618
693
  });
619
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
+ }
620
788
  /**
621
789
  * Creates request options for getScormAsset without sending the request
622
790
  */
@@ -933,3 +1101,47 @@ export class PlayerApi extends runtime.BaseAPI {
933
1101
  });
934
1102
  }
935
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
+ };
@@ -30,6 +30,12 @@ export interface GetResourceSession {
30
30
  * @memberof GetResourceSession
31
31
  */
32
32
  userId: string;
33
+ /**
34
+ *
35
+ * @type {string}
36
+ * @memberof GetResourceSession
37
+ */
38
+ userName: string;
33
39
  /**
34
40
  *
35
41
  * @type {ResourceSessionEnvironment}
@@ -42,12 +48,24 @@ export interface GetResourceSession {
42
48
  * @memberof GetResourceSession
43
49
  */
44
50
  courseId?: string | null;
51
+ /**
52
+ *
53
+ * @type {string}
54
+ * @memberof GetResourceSession
55
+ */
56
+ courseName?: string | null;
45
57
  /**
46
58
  *
47
59
  * @type {string}
48
60
  * @memberof GetResourceSession
49
61
  */
50
62
  courseVersionId?: string | null;
63
+ /**
64
+ *
65
+ * @type {number}
66
+ * @memberof GetResourceSession
67
+ */
68
+ courseVersionNumber?: number | null;
51
69
  /**
52
70
  *
53
71
  * @type {string}
@@ -66,6 +84,18 @@ export interface GetResourceSession {
66
84
  * @memberof GetResourceSession
67
85
  */
68
86
  contentLibraryVersionId: string;
87
+ /**
88
+ *
89
+ * @type {number}
90
+ * @memberof GetResourceSession
91
+ */
92
+ contentLibraryVersionNumber: number;
93
+ /**
94
+ *
95
+ * @type {string}
96
+ * @memberof GetResourceSession
97
+ */
98
+ contentLibraryVersionStatus: string;
69
99
  /**
70
100
  *
71
101
  * @type {string}
@@ -22,12 +22,18 @@ export function instanceOfGetResourceSession(value) {
22
22
  return false;
23
23
  if (!('userId' in value) || value['userId'] === undefined)
24
24
  return false;
25
+ if (!('userName' in value) || value['userName'] === undefined)
26
+ return false;
25
27
  if (!('environment' in value) || value['environment'] === undefined)
26
28
  return false;
27
29
  if (!('contentLibraryItemId' in value) || value['contentLibraryItemId'] === undefined)
28
30
  return false;
29
31
  if (!('contentLibraryVersionId' in value) || value['contentLibraryVersionId'] === undefined)
30
32
  return false;
33
+ if (!('contentLibraryVersionNumber' in value) || value['contentLibraryVersionNumber'] === undefined)
34
+ return false;
35
+ if (!('contentLibraryVersionStatus' in value) || value['contentLibraryVersionStatus'] === undefined)
36
+ return false;
31
37
  if (!('resourceName' in value) || value['resourceName'] === undefined)
32
38
  return false;
33
39
  if (!('resourceType' in value) || value['resourceType'] === undefined)
@@ -56,12 +62,17 @@ export function GetResourceSessionFromJSONTyped(json, ignoreDiscriminator) {
56
62
  return {
57
63
  'id': json['id'],
58
64
  'userId': json['user_id'],
65
+ 'userName': json['user_name'],
59
66
  'environment': ResourceSessionEnvironmentFromJSON(json['environment']),
60
67
  'courseId': json['course_id'] == null ? undefined : json['course_id'],
68
+ 'courseName': json['course_name'] == null ? undefined : json['course_name'],
61
69
  'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
70
+ 'courseVersionNumber': json['course_version_number'] == null ? undefined : json['course_version_number'],
62
71
  'itemId': json['item_id'] == null ? undefined : json['item_id'],
63
72
  'contentLibraryItemId': json['content_library_item_id'],
64
73
  'contentLibraryVersionId': json['content_library_version_id'],
74
+ 'contentLibraryVersionNumber': json['content_library_version_number'],
75
+ 'contentLibraryVersionStatus': json['content_library_version_status'],
65
76
  'resourceName': json['resource_name'],
66
77
  'resourceType': ResourceTypeFromJSON(json['resource_type']),
67
78
  'launchMode': json['launch_mode'] == null ? undefined : ContentLaunchModeFromJSON(json['launch_mode']),
@@ -88,12 +99,17 @@ export function GetResourceSessionToJSONTyped(value, ignoreDiscriminator = false
88
99
  return {
89
100
  'id': value['id'],
90
101
  'user_id': value['userId'],
102
+ 'user_name': value['userName'],
91
103
  'environment': ResourceSessionEnvironmentToJSON(value['environment']),
92
104
  'course_id': value['courseId'],
105
+ 'course_name': value['courseName'],
93
106
  'course_version_id': value['courseVersionId'],
107
+ 'course_version_number': value['courseVersionNumber'],
94
108
  'item_id': value['itemId'],
95
109
  'content_library_item_id': value['contentLibraryItemId'],
96
110
  'content_library_version_id': value['contentLibraryVersionId'],
111
+ 'content_library_version_number': value['contentLibraryVersionNumber'],
112
+ 'content_library_version_status': value['contentLibraryVersionStatus'],
97
113
  'resource_name': value['resourceName'],
98
114
  'resource_type': ResourceTypeToJSON(value['resourceType']),
99
115
  'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
@@ -0,0 +1,76 @@
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 { GetResourceSessionDiagnosticsResource } from './GetResourceSessionDiagnosticsResource';
13
+ import type { GetResourceSessionDiagnosticsScormSummary } from './GetResourceSessionDiagnosticsScormSummary';
14
+ import type { GetResourceSessionDiagnosticsUser } from './GetResourceSessionDiagnosticsUser';
15
+ import type { GetResourceSession } from './GetResourceSession';
16
+ import type { GetResourceSessionDiagnosticsCourseContext } from './GetResourceSessionDiagnosticsCourseContext';
17
+ import type { GetResourceSessionDiagnosticsVersion } from './GetResourceSessionDiagnosticsVersion';
18
+ /**
19
+ * Administrator diagnostics for a resource session and its exact resource-version pin.
20
+ * @export
21
+ * @interface GetResourceSessionDiagnostics
22
+ */
23
+ export interface GetResourceSessionDiagnostics {
24
+ /**
25
+ *
26
+ * @type {GetResourceSession}
27
+ * @memberof GetResourceSessionDiagnostics
28
+ */
29
+ session: GetResourceSession;
30
+ /**
31
+ *
32
+ * @type {{ [key: string]: any; }}
33
+ * @memberof GetResourceSessionDiagnostics
34
+ */
35
+ sessionData: {
36
+ [key: string]: any;
37
+ };
38
+ /**
39
+ *
40
+ * @type {GetResourceSessionDiagnosticsUser}
41
+ * @memberof GetResourceSessionDiagnostics
42
+ */
43
+ user: GetResourceSessionDiagnosticsUser;
44
+ /**
45
+ *
46
+ * @type {GetResourceSessionDiagnosticsResource}
47
+ * @memberof GetResourceSessionDiagnostics
48
+ */
49
+ resource: GetResourceSessionDiagnosticsResource;
50
+ /**
51
+ *
52
+ * @type {GetResourceSessionDiagnosticsVersion}
53
+ * @memberof GetResourceSessionDiagnostics
54
+ */
55
+ version: GetResourceSessionDiagnosticsVersion;
56
+ /**
57
+ *
58
+ * @type {GetResourceSessionDiagnosticsCourseContext}
59
+ * @memberof GetResourceSessionDiagnostics
60
+ */
61
+ courseContext?: GetResourceSessionDiagnosticsCourseContext | null;
62
+ /**
63
+ *
64
+ * @type {GetResourceSessionDiagnosticsScormSummary}
65
+ * @memberof GetResourceSessionDiagnostics
66
+ */
67
+ scormSummary?: GetResourceSessionDiagnosticsScormSummary | null;
68
+ }
69
+ /**
70
+ * Check if a given object implements the GetResourceSessionDiagnostics interface.
71
+ */
72
+ export declare function instanceOfGetResourceSessionDiagnostics(value: object): value is GetResourceSessionDiagnostics;
73
+ export declare function GetResourceSessionDiagnosticsFromJSON(json: any): GetResourceSessionDiagnostics;
74
+ export declare function GetResourceSessionDiagnosticsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionDiagnostics;
75
+ export declare function GetResourceSessionDiagnosticsToJSON(json: any): GetResourceSessionDiagnostics;
76
+ export declare function GetResourceSessionDiagnosticsToJSONTyped(value?: GetResourceSessionDiagnostics | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,69 @@
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 { GetResourceSessionDiagnosticsResourceFromJSON, GetResourceSessionDiagnosticsResourceToJSON, } from './GetResourceSessionDiagnosticsResource';
15
+ import { GetResourceSessionDiagnosticsScormSummaryFromJSON, GetResourceSessionDiagnosticsScormSummaryToJSON, } from './GetResourceSessionDiagnosticsScormSummary';
16
+ import { GetResourceSessionDiagnosticsUserFromJSON, GetResourceSessionDiagnosticsUserToJSON, } from './GetResourceSessionDiagnosticsUser';
17
+ import { GetResourceSessionFromJSON, GetResourceSessionToJSON, } from './GetResourceSession';
18
+ import { GetResourceSessionDiagnosticsCourseContextFromJSON, GetResourceSessionDiagnosticsCourseContextToJSON, } from './GetResourceSessionDiagnosticsCourseContext';
19
+ import { GetResourceSessionDiagnosticsVersionFromJSON, GetResourceSessionDiagnosticsVersionToJSON, } from './GetResourceSessionDiagnosticsVersion';
20
+ /**
21
+ * Check if a given object implements the GetResourceSessionDiagnostics interface.
22
+ */
23
+ export function instanceOfGetResourceSessionDiagnostics(value) {
24
+ if (!('session' in value) || value['session'] === undefined)
25
+ return false;
26
+ if (!('sessionData' in value) || value['sessionData'] === undefined)
27
+ return false;
28
+ if (!('user' in value) || value['user'] === undefined)
29
+ return false;
30
+ if (!('resource' in value) || value['resource'] === undefined)
31
+ return false;
32
+ if (!('version' in value) || value['version'] === undefined)
33
+ return false;
34
+ return true;
35
+ }
36
+ export function GetResourceSessionDiagnosticsFromJSON(json) {
37
+ return GetResourceSessionDiagnosticsFromJSONTyped(json, false);
38
+ }
39
+ export function GetResourceSessionDiagnosticsFromJSONTyped(json, ignoreDiscriminator) {
40
+ if (json == null) {
41
+ return json;
42
+ }
43
+ return {
44
+ 'session': GetResourceSessionFromJSON(json['session']),
45
+ 'sessionData': json['session_data'],
46
+ 'user': GetResourceSessionDiagnosticsUserFromJSON(json['user']),
47
+ 'resource': GetResourceSessionDiagnosticsResourceFromJSON(json['resource']),
48
+ 'version': GetResourceSessionDiagnosticsVersionFromJSON(json['version']),
49
+ 'courseContext': json['course_context'] == null ? undefined : GetResourceSessionDiagnosticsCourseContextFromJSON(json['course_context']),
50
+ 'scormSummary': json['scorm_summary'] == null ? undefined : GetResourceSessionDiagnosticsScormSummaryFromJSON(json['scorm_summary']),
51
+ };
52
+ }
53
+ export function GetResourceSessionDiagnosticsToJSON(json) {
54
+ return GetResourceSessionDiagnosticsToJSONTyped(json, false);
55
+ }
56
+ export function GetResourceSessionDiagnosticsToJSONTyped(value, ignoreDiscriminator = false) {
57
+ if (value == null) {
58
+ return value;
59
+ }
60
+ return {
61
+ 'session': GetResourceSessionToJSON(value['session']),
62
+ 'session_data': value['sessionData'],
63
+ 'user': GetResourceSessionDiagnosticsUserToJSON(value['user']),
64
+ 'resource': GetResourceSessionDiagnosticsResourceToJSON(value['resource']),
65
+ 'version': GetResourceSessionDiagnosticsVersionToJSON(value['version']),
66
+ 'course_context': GetResourceSessionDiagnosticsCourseContextToJSON(value['courseContext']),
67
+ 'scorm_summary': GetResourceSessionDiagnosticsScormSummaryToJSON(value['scormSummary']),
68
+ };
69
+ }