@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
@@ -13,6 +13,41 @@
13
13
  */
14
14
 
15
15
  import * as runtime from '../runtime';
16
+ import {
17
+ type GetResourceSession,
18
+ GetResourceSessionFromJSON,
19
+ GetResourceSessionToJSON,
20
+ } from '../models/GetResourceSession';
21
+ import {
22
+ type GetResourceSessionDiagnostics,
23
+ GetResourceSessionDiagnosticsFromJSON,
24
+ GetResourceSessionDiagnosticsToJSON,
25
+ } from '../models/GetResourceSessionDiagnostics';
26
+ import {
27
+ type GetResourceSessionList,
28
+ GetResourceSessionListFromJSON,
29
+ GetResourceSessionListToJSON,
30
+ } from '../models/GetResourceSessionList';
31
+ import {
32
+ type GetResourceSessionScormApiLogs,
33
+ GetResourceSessionScormApiLogsFromJSON,
34
+ GetResourceSessionScormApiLogsToJSON,
35
+ } from '../models/GetResourceSessionScormApiLogs';
36
+ import {
37
+ type GetResourceSessionScormData,
38
+ GetResourceSessionScormDataFromJSON,
39
+ GetResourceSessionScormDataToJSON,
40
+ } from '../models/GetResourceSessionScormData';
41
+ import {
42
+ type ResourceSessionEnvironment,
43
+ ResourceSessionEnvironmentFromJSON,
44
+ ResourceSessionEnvironmentToJSON,
45
+ } from '../models/ResourceSessionEnvironment';
46
+ import {
47
+ type ResourceType,
48
+ ResourceTypeFromJSON,
49
+ ResourceTypeToJSON,
50
+ } from '../models/ResourceType';
16
51
  import {
17
52
  type ScormGetValueResponse,
18
53
  ScormGetValueResponseFromJSON,
@@ -72,10 +107,60 @@ export interface GetResourceScormValueRequest {
72
107
  key: string;
73
108
  }
74
109
 
110
+ export interface GetResourceSessionRequest {
111
+ sessionId: string;
112
+ }
113
+
114
+ export interface GetResourceSessionAssetRequest {
115
+ sessionId: string;
116
+ assetPath: string;
117
+ }
118
+
119
+ export interface GetResourceSessionDiagnosticsRequest {
120
+ sessionId: string;
121
+ }
122
+
123
+ export interface GetResourceSessionListRequest {
124
+ userId?: string;
125
+ resourceId?: string;
126
+ versionId?: string;
127
+ courseId?: string;
128
+ courseVersionId?: string;
129
+ itemId?: string;
130
+ resourceType?: ResourceType;
131
+ environment?: ResourceSessionEnvironment;
132
+ completionStatus?: GetResourceSessionListCompletionStatusEnum;
133
+ gradeStatus?: GetResourceSessionListGradeStatusEnum;
134
+ isCurrent?: boolean;
135
+ attemptNumber?: number;
136
+ createdFrom?: number;
137
+ createdTo?: number;
138
+ updatedFrom?: number;
139
+ updatedTo?: number;
140
+ hasScormErrors?: boolean;
141
+ sortBy?: GetResourceSessionListSortByEnum;
142
+ sortDirection?: GetResourceSessionListSortDirectionEnum;
143
+ page?: number;
144
+ pageSize?: number;
145
+ }
146
+
75
147
  export interface GetResourceSessionPlayerRequest {
76
148
  sessionId: string;
77
149
  }
78
150
 
151
+ export interface GetResourceSessionScormApiLogsRequest {
152
+ sessionId: string;
153
+ method?: GetResourceSessionScormApiLogsMethodEnum;
154
+ element?: string;
155
+ errorsOnly?: boolean;
156
+ page?: number;
157
+ pageSize?: number;
158
+ }
159
+
160
+ export interface GetResourceSessionScormDataRequest {
161
+ sessionId: string;
162
+ }
163
+
79
164
  export interface GetScormAssetRequest {
80
165
  contentId: string;
81
166
  assetPath: string;
@@ -97,6 +182,10 @@ export interface InitializeResourceScormSessionRequest {
97
182
  sessionId: string;
98
183
  }
99
184
 
185
+ export interface PostResourceSessionCompleteRequest {
186
+ sessionId: string;
187
+ }
188
+
100
189
  export interface SetResourceScormValueRequest {
101
190
  sessionId: string;
102
191
  scormSetValueRequest: ScormSetValueRequest;
@@ -580,6 +669,270 @@ export class PlayerApi extends runtime.BaseAPI {
580
669
  return await response.value();
581
670
  }
582
671
 
672
+ /**
673
+ * Creates request options for getResourceSession without sending the request
674
+ */
675
+ async getResourceSessionRequestOpts(requestParameters: GetResourceSessionRequest): Promise<runtime.RequestOpts> {
676
+ if (requestParameters['sessionId'] == null) {
677
+ throw new runtime.RequiredError(
678
+ 'sessionId',
679
+ 'Required parameter "sessionId" was null or undefined when calling getResourceSession().'
680
+ );
681
+ }
682
+
683
+ const queryParameters: any = {};
684
+
685
+ const headerParameters: runtime.HTTPHeaders = {};
686
+
687
+
688
+ let urlPath = `/resource/sessions/{sessionId}`;
689
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
690
+
691
+ return {
692
+ path: urlPath,
693
+ method: 'GET',
694
+ headers: headerParameters,
695
+ query: queryParameters,
696
+ };
697
+ }
698
+
699
+ /**
700
+ * Get a resource session
701
+ */
702
+ async getResourceSessionRaw(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>> {
703
+ const requestOptions = await this.getResourceSessionRequestOpts(requestParameters);
704
+ const response = await this.request(requestOptions, initOverrides);
705
+
706
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionFromJSON(jsonValue));
707
+ }
708
+
709
+ /**
710
+ * Get a resource session
711
+ */
712
+ async getResourceSession(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession> {
713
+ const response = await this.getResourceSessionRaw(requestParameters, initOverrides);
714
+ return await response.value();
715
+ }
716
+
717
+ /**
718
+ * Creates request options for getResourceSessionAsset without sending the request
719
+ */
720
+ async getResourceSessionAssetRequestOpts(requestParameters: GetResourceSessionAssetRequest): Promise<runtime.RequestOpts> {
721
+ if (requestParameters['sessionId'] == null) {
722
+ throw new runtime.RequiredError(
723
+ 'sessionId',
724
+ 'Required parameter "sessionId" was null or undefined when calling getResourceSessionAsset().'
725
+ );
726
+ }
727
+
728
+ if (requestParameters['assetPath'] == null) {
729
+ throw new runtime.RequiredError(
730
+ 'assetPath',
731
+ 'Required parameter "assetPath" was null or undefined when calling getResourceSessionAsset().'
732
+ );
733
+ }
734
+
735
+ const queryParameters: any = {};
736
+
737
+ const headerParameters: runtime.HTTPHeaders = {};
738
+
739
+
740
+ let urlPath = `/resource/sessions/{sessionId}/asset/{assetPath}`;
741
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
742
+ urlPath = urlPath.replace('{assetPath}', encodeURIComponent(String(requestParameters['assetPath'])));
743
+
744
+ return {
745
+ path: urlPath,
746
+ method: 'GET',
747
+ headers: headerParameters,
748
+ query: queryParameters,
749
+ };
750
+ }
751
+
752
+ /**
753
+ * Stream an asset pinned to a resource session
754
+ */
755
+ async getResourceSessionAssetRaw(requestParameters: GetResourceSessionAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
756
+ const requestOptions = await this.getResourceSessionAssetRequestOpts(requestParameters);
757
+ const response = await this.request(requestOptions, initOverrides);
758
+
759
+ return new runtime.BlobApiResponse(response);
760
+ }
761
+
762
+ /**
763
+ * Stream an asset pinned to a resource session
764
+ */
765
+ async getResourceSessionAsset(requestParameters: GetResourceSessionAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
766
+ const response = await this.getResourceSessionAssetRaw(requestParameters, initOverrides);
767
+ return await response.value();
768
+ }
769
+
770
+ /**
771
+ * Creates request options for getResourceSessionDiagnostics without sending the request
772
+ */
773
+ async getResourceSessionDiagnosticsRequestOpts(requestParameters: GetResourceSessionDiagnosticsRequest): Promise<runtime.RequestOpts> {
774
+ if (requestParameters['sessionId'] == null) {
775
+ throw new runtime.RequiredError(
776
+ 'sessionId',
777
+ 'Required parameter "sessionId" was null or undefined when calling getResourceSessionDiagnostics().'
778
+ );
779
+ }
780
+
781
+ const queryParameters: any = {};
782
+
783
+ const headerParameters: runtime.HTTPHeaders = {};
784
+
785
+
786
+ let urlPath = `/resource/sessions/{sessionId}/diagnostics`;
787
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
788
+
789
+ return {
790
+ path: urlPath,
791
+ method: 'GET',
792
+ headers: headerParameters,
793
+ query: queryParameters,
794
+ };
795
+ }
796
+
797
+ /**
798
+ * Get administrator diagnostics for a resource session
799
+ */
800
+ async getResourceSessionDiagnosticsRaw(requestParameters: GetResourceSessionDiagnosticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionDiagnostics>> {
801
+ const requestOptions = await this.getResourceSessionDiagnosticsRequestOpts(requestParameters);
802
+ const response = await this.request(requestOptions, initOverrides);
803
+
804
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionDiagnosticsFromJSON(jsonValue));
805
+ }
806
+
807
+ /**
808
+ * Get administrator diagnostics for a resource session
809
+ */
810
+ async getResourceSessionDiagnostics(requestParameters: GetResourceSessionDiagnosticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionDiagnostics> {
811
+ const response = await this.getResourceSessionDiagnosticsRaw(requestParameters, initOverrides);
812
+ return await response.value();
813
+ }
814
+
815
+ /**
816
+ * Creates request options for getResourceSessionList without sending the request
817
+ */
818
+ async getResourceSessionListRequestOpts(requestParameters: GetResourceSessionListRequest): Promise<runtime.RequestOpts> {
819
+ const queryParameters: any = {};
820
+
821
+ if (requestParameters['userId'] != null) {
822
+ queryParameters['user_id'] = requestParameters['userId'];
823
+ }
824
+
825
+ if (requestParameters['resourceId'] != null) {
826
+ queryParameters['resource_id'] = requestParameters['resourceId'];
827
+ }
828
+
829
+ if (requestParameters['versionId'] != null) {
830
+ queryParameters['version_id'] = requestParameters['versionId'];
831
+ }
832
+
833
+ if (requestParameters['courseId'] != null) {
834
+ queryParameters['course_id'] = requestParameters['courseId'];
835
+ }
836
+
837
+ if (requestParameters['courseVersionId'] != null) {
838
+ queryParameters['course_version_id'] = requestParameters['courseVersionId'];
839
+ }
840
+
841
+ if (requestParameters['itemId'] != null) {
842
+ queryParameters['item_id'] = requestParameters['itemId'];
843
+ }
844
+
845
+ if (requestParameters['resourceType'] != null) {
846
+ queryParameters['resource_type'] = requestParameters['resourceType'];
847
+ }
848
+
849
+ if (requestParameters['environment'] != null) {
850
+ queryParameters['environment'] = requestParameters['environment'];
851
+ }
852
+
853
+ if (requestParameters['completionStatus'] != null) {
854
+ queryParameters['completion_status'] = requestParameters['completionStatus'];
855
+ }
856
+
857
+ if (requestParameters['gradeStatus'] != null) {
858
+ queryParameters['grade_status'] = requestParameters['gradeStatus'];
859
+ }
860
+
861
+ if (requestParameters['isCurrent'] != null) {
862
+ queryParameters['is_current'] = requestParameters['isCurrent'];
863
+ }
864
+
865
+ if (requestParameters['attemptNumber'] != null) {
866
+ queryParameters['attempt_number'] = requestParameters['attemptNumber'];
867
+ }
868
+
869
+ if (requestParameters['createdFrom'] != null) {
870
+ queryParameters['created_from'] = requestParameters['createdFrom'];
871
+ }
872
+
873
+ if (requestParameters['createdTo'] != null) {
874
+ queryParameters['created_to'] = requestParameters['createdTo'];
875
+ }
876
+
877
+ if (requestParameters['updatedFrom'] != null) {
878
+ queryParameters['updated_from'] = requestParameters['updatedFrom'];
879
+ }
880
+
881
+ if (requestParameters['updatedTo'] != null) {
882
+ queryParameters['updated_to'] = requestParameters['updatedTo'];
883
+ }
884
+
885
+ if (requestParameters['hasScormErrors'] != null) {
886
+ queryParameters['has_scorm_errors'] = requestParameters['hasScormErrors'];
887
+ }
888
+
889
+ if (requestParameters['sortBy'] != null) {
890
+ queryParameters['sort_by'] = requestParameters['sortBy'];
891
+ }
892
+
893
+ if (requestParameters['sortDirection'] != null) {
894
+ queryParameters['sort_direction'] = requestParameters['sortDirection'];
895
+ }
896
+
897
+ if (requestParameters['page'] != null) {
898
+ queryParameters['page'] = requestParameters['page'];
899
+ }
900
+
901
+ if (requestParameters['pageSize'] != null) {
902
+ queryParameters['pageSize'] = requestParameters['pageSize'];
903
+ }
904
+
905
+ const headerParameters: runtime.HTTPHeaders = {};
906
+
907
+
908
+ let urlPath = `/resource/sessions`;
909
+
910
+ return {
911
+ path: urlPath,
912
+ method: 'GET',
913
+ headers: headerParameters,
914
+ query: queryParameters,
915
+ };
916
+ }
917
+
918
+ /**
919
+ * List resource sessions for the selected portal
920
+ */
921
+ async getResourceSessionListRaw(requestParameters: GetResourceSessionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionList>> {
922
+ const requestOptions = await this.getResourceSessionListRequestOpts(requestParameters);
923
+ const response = await this.request(requestOptions, initOverrides);
924
+
925
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionListFromJSON(jsonValue));
926
+ }
927
+
928
+ /**
929
+ * List resource sessions for the selected portal
930
+ */
931
+ async getResourceSessionList(requestParameters: GetResourceSessionListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionList> {
932
+ const response = await this.getResourceSessionListRaw(requestParameters, initOverrides);
933
+ return await response.value();
934
+ }
935
+
583
936
  /**
584
937
  * Creates request options for getResourceSessionPlayer without sending the request
585
938
  */
@@ -629,6 +982,116 @@ export class PlayerApi extends runtime.BaseAPI {
629
982
  return await response.value();
630
983
  }
631
984
 
985
+ /**
986
+ * Creates request options for getResourceSessionScormApiLogs without sending the request
987
+ */
988
+ async getResourceSessionScormApiLogsRequestOpts(requestParameters: GetResourceSessionScormApiLogsRequest): Promise<runtime.RequestOpts> {
989
+ if (requestParameters['sessionId'] == null) {
990
+ throw new runtime.RequiredError(
991
+ 'sessionId',
992
+ 'Required parameter "sessionId" was null or undefined when calling getResourceSessionScormApiLogs().'
993
+ );
994
+ }
995
+
996
+ const queryParameters: any = {};
997
+
998
+ if (requestParameters['method'] != null) {
999
+ queryParameters['method'] = requestParameters['method'];
1000
+ }
1001
+
1002
+ if (requestParameters['element'] != null) {
1003
+ queryParameters['element'] = requestParameters['element'];
1004
+ }
1005
+
1006
+ if (requestParameters['errorsOnly'] != null) {
1007
+ queryParameters['errors_only'] = requestParameters['errorsOnly'];
1008
+ }
1009
+
1010
+ if (requestParameters['page'] != null) {
1011
+ queryParameters['page'] = requestParameters['page'];
1012
+ }
1013
+
1014
+ if (requestParameters['pageSize'] != null) {
1015
+ queryParameters['pageSize'] = requestParameters['pageSize'];
1016
+ }
1017
+
1018
+ const headerParameters: runtime.HTTPHeaders = {};
1019
+
1020
+
1021
+ let urlPath = `/resource/sessions/{sessionId}/api-logs`;
1022
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
1023
+
1024
+ return {
1025
+ path: urlPath,
1026
+ method: 'GET',
1027
+ headers: headerParameters,
1028
+ query: queryParameters,
1029
+ };
1030
+ }
1031
+
1032
+ /**
1033
+ * Get SCORM runtime logs for a resource session
1034
+ */
1035
+ async getResourceSessionScormApiLogsRaw(requestParameters: GetResourceSessionScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionScormApiLogs>> {
1036
+ const requestOptions = await this.getResourceSessionScormApiLogsRequestOpts(requestParameters);
1037
+ const response = await this.request(requestOptions, initOverrides);
1038
+
1039
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionScormApiLogsFromJSON(jsonValue));
1040
+ }
1041
+
1042
+ /**
1043
+ * Get SCORM runtime logs for a resource session
1044
+ */
1045
+ async getResourceSessionScormApiLogs(requestParameters: GetResourceSessionScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionScormApiLogs> {
1046
+ const response = await this.getResourceSessionScormApiLogsRaw(requestParameters, initOverrides);
1047
+ return await response.value();
1048
+ }
1049
+
1050
+ /**
1051
+ * Creates request options for getResourceSessionScormData without sending the request
1052
+ */
1053
+ async getResourceSessionScormDataRequestOpts(requestParameters: GetResourceSessionScormDataRequest): Promise<runtime.RequestOpts> {
1054
+ if (requestParameters['sessionId'] == null) {
1055
+ throw new runtime.RequiredError(
1056
+ 'sessionId',
1057
+ 'Required parameter "sessionId" was null or undefined when calling getResourceSessionScormData().'
1058
+ );
1059
+ }
1060
+
1061
+ const queryParameters: any = {};
1062
+
1063
+ const headerParameters: runtime.HTTPHeaders = {};
1064
+
1065
+
1066
+ let urlPath = `/resource/sessions/{sessionId}/scorm-data`;
1067
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
1068
+
1069
+ return {
1070
+ path: urlPath,
1071
+ method: 'GET',
1072
+ headers: headerParameters,
1073
+ query: queryParameters,
1074
+ };
1075
+ }
1076
+
1077
+ /**
1078
+ * Get SCORM CMI data for a resource session
1079
+ */
1080
+ async getResourceSessionScormDataRaw(requestParameters: GetResourceSessionScormDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionScormData>> {
1081
+ const requestOptions = await this.getResourceSessionScormDataRequestOpts(requestParameters);
1082
+ const response = await this.request(requestOptions, initOverrides);
1083
+
1084
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionScormDataFromJSON(jsonValue));
1085
+ }
1086
+
1087
+ /**
1088
+ * Get SCORM CMI data for a resource session
1089
+ */
1090
+ async getResourceSessionScormData(requestParameters: GetResourceSessionScormDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionScormData> {
1091
+ const response = await this.getResourceSessionScormDataRaw(requestParameters, initOverrides);
1092
+ return await response.value();
1093
+ }
1094
+
632
1095
  /**
633
1096
  * Creates request options for getScormAsset without sending the request
634
1097
  */
@@ -857,6 +1320,51 @@ export class PlayerApi extends runtime.BaseAPI {
857
1320
  await this.initializeResourceScormSessionRaw(requestParameters, initOverrides);
858
1321
  }
859
1322
 
1323
+ /**
1324
+ * Creates request options for postResourceSessionComplete without sending the request
1325
+ */
1326
+ async postResourceSessionCompleteRequestOpts(requestParameters: PostResourceSessionCompleteRequest): Promise<runtime.RequestOpts> {
1327
+ if (requestParameters['sessionId'] == null) {
1328
+ throw new runtime.RequiredError(
1329
+ 'sessionId',
1330
+ 'Required parameter "sessionId" was null or undefined when calling postResourceSessionComplete().'
1331
+ );
1332
+ }
1333
+
1334
+ const queryParameters: any = {};
1335
+
1336
+ const headerParameters: runtime.HTTPHeaders = {};
1337
+
1338
+
1339
+ let urlPath = `/resource/sessions/{sessionId}/complete`;
1340
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
1341
+
1342
+ return {
1343
+ path: urlPath,
1344
+ method: 'POST',
1345
+ headers: headerParameters,
1346
+ query: queryParameters,
1347
+ };
1348
+ }
1349
+
1350
+ /**
1351
+ * Complete a non-SCORM resource session
1352
+ */
1353
+ async postResourceSessionCompleteRaw(requestParameters: PostResourceSessionCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>> {
1354
+ const requestOptions = await this.postResourceSessionCompleteRequestOpts(requestParameters);
1355
+ const response = await this.request(requestOptions, initOverrides);
1356
+
1357
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionFromJSON(jsonValue));
1358
+ }
1359
+
1360
+ /**
1361
+ * Complete a non-SCORM resource session
1362
+ */
1363
+ async postResourceSessionComplete(requestParameters: PostResourceSessionCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession> {
1364
+ const response = await this.postResourceSessionCompleteRaw(requestParameters, initOverrides);
1365
+ return await response.value();
1366
+ }
1367
+
860
1368
  /**
861
1369
  * Creates request options for setResourceScormValue without sending the request
862
1370
  */
@@ -957,3 +1465,53 @@ export class PlayerApi extends runtime.BaseAPI {
957
1465
  }
958
1466
 
959
1467
  }
1468
+
1469
+ /**
1470
+ * @export
1471
+ */
1472
+ export const GetResourceSessionListCompletionStatusEnum = {
1473
+ NotAttempted: 'not_attempted',
1474
+ InProgress: 'in_progress',
1475
+ Completed: 'completed'
1476
+ } as const;
1477
+ export type GetResourceSessionListCompletionStatusEnum = typeof GetResourceSessionListCompletionStatusEnum[keyof typeof GetResourceSessionListCompletionStatusEnum];
1478
+ /**
1479
+ * @export
1480
+ */
1481
+ export const GetResourceSessionListGradeStatusEnum = {
1482
+ Ungraded: 'ungraded',
1483
+ Passed: 'passed',
1484
+ Failed: 'failed',
1485
+ PointsEarned: 'points_earned',
1486
+ PercentageEarned: 'percentage_earned',
1487
+ NotApplicable: 'not_applicable'
1488
+ } as const;
1489
+ export type GetResourceSessionListGradeStatusEnum = typeof GetResourceSessionListGradeStatusEnum[keyof typeof GetResourceSessionListGradeStatusEnum];
1490
+ /**
1491
+ * @export
1492
+ */
1493
+ export const GetResourceSessionListSortByEnum = {
1494
+ CreatedAt: 'created_at',
1495
+ UpdatedAt: 'updated_at',
1496
+ AttemptNumber: 'attempt_number'
1497
+ } as const;
1498
+ export type GetResourceSessionListSortByEnum = typeof GetResourceSessionListSortByEnum[keyof typeof GetResourceSessionListSortByEnum];
1499
+ /**
1500
+ * @export
1501
+ */
1502
+ export const GetResourceSessionListSortDirectionEnum = {
1503
+ Asc: 'asc',
1504
+ Desc: 'desc'
1505
+ } as const;
1506
+ export type GetResourceSessionListSortDirectionEnum = typeof GetResourceSessionListSortDirectionEnum[keyof typeof GetResourceSessionListSortDirectionEnum];
1507
+ /**
1508
+ * @export
1509
+ */
1510
+ export const GetResourceSessionScormApiLogsMethodEnum = {
1511
+ Initialize: 'Initialize',
1512
+ GetValue: 'GetValue',
1513
+ SetValue: 'SetValue',
1514
+ Commit: 'Commit',
1515
+ Terminate: 'Terminate'
1516
+ } as const;
1517
+ export type GetResourceSessionScormApiLogsMethodEnum = typeof GetResourceSessionScormApiLogsMethodEnum[keyof typeof GetResourceSessionScormApiLogsMethodEnum];
@@ -13,6 +13,13 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
+ import type { ResourceSessionEnvironment } from './ResourceSessionEnvironment';
17
+ import {
18
+ ResourceSessionEnvironmentFromJSON,
19
+ ResourceSessionEnvironmentFromJSONTyped,
20
+ ResourceSessionEnvironmentToJSON,
21
+ ResourceSessionEnvironmentToJSONTyped,
22
+ } from './ResourceSessionEnvironment';
16
23
  import type { ResourceType } from './ResourceType';
17
24
  import {
18
25
  ResourceTypeFromJSON,
@@ -40,6 +47,12 @@ export interface GetCourseVersionItemSession {
40
47
  * @memberof GetCourseVersionItemSession
41
48
  */
42
49
  id: string;
50
+ /**
51
+ *
52
+ * @type {ResourceSessionEnvironment}
53
+ * @memberof GetCourseVersionItemSession
54
+ */
55
+ environment: ResourceSessionEnvironment;
43
56
  /**
44
57
  *
45
58
  * @type {string}
@@ -139,6 +152,7 @@ export interface GetCourseVersionItemSession {
139
152
  */
140
153
  export function instanceOfGetCourseVersionItemSession(value: object): value is GetCourseVersionItemSession {
141
154
  if (!('id' in value) || value['id'] === undefined) return false;
155
+ if (!('environment' in value) || value['environment'] === undefined) return false;
142
156
  if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
143
157
  if (!('itemId' in value) || value['itemId'] === undefined) return false;
144
158
  if (!('contentLibraryItemId' in value) || value['contentLibraryItemId'] === undefined) return false;
@@ -166,6 +180,7 @@ export function GetCourseVersionItemSessionFromJSONTyped(json: any, ignoreDiscri
166
180
  return {
167
181
 
168
182
  'id': json['id'],
183
+ 'environment': ResourceSessionEnvironmentFromJSON(json['environment']),
169
184
  'courseVersionId': json['course_version_id'],
170
185
  'itemId': json['item_id'],
171
186
  'contentLibraryItemId': json['content_library_item_id'],
@@ -196,6 +211,7 @@ export function GetCourseVersionItemSessionToJSONTyped(value?: GetCourseVersionI
196
211
  return {
197
212
 
198
213
  'id': value['id'],
214
+ 'environment': ResourceSessionEnvironmentToJSON(value['environment']),
199
215
  'course_version_id': value['courseVersionId'],
200
216
  'item_id': value['itemId'],
201
217
  'content_library_item_id': value['contentLibraryItemId'],