@easyedu/js-lsm-api 1.118.0 → 1.120.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 (182) hide show
  1. package/.openapi-generator/FILES +42 -0
  2. package/README.md +34 -2
  3. package/dist/apis/CourseApi.d.ts +55 -0
  4. package/dist/apis/CourseApi.js +148 -0
  5. package/dist/apis/DispatchApi.d.ts +121 -5
  6. package/dist/apis/DispatchApi.js +303 -8
  7. package/dist/apis/PlayerApi.d.ts +26 -6
  8. package/dist/apis/PlayerApi.js +57 -6
  9. package/dist/esm/apis/CourseApi.d.ts +55 -0
  10. package/dist/esm/apis/CourseApi.js +148 -0
  11. package/dist/esm/apis/DispatchApi.d.ts +121 -5
  12. package/dist/esm/apis/DispatchApi.js +303 -8
  13. package/dist/esm/apis/PlayerApi.d.ts +26 -6
  14. package/dist/esm/apis/PlayerApi.js +57 -6
  15. package/dist/esm/models/DispatchTokenResponse.d.ts +57 -0
  16. package/dist/esm/models/DispatchTokenResponse.js +61 -0
  17. package/dist/esm/models/GetCourseExport.d.ts +62 -0
  18. package/dist/esm/models/GetCourseExport.js +44 -0
  19. package/dist/esm/models/GetDispatchCourse.d.ts +82 -0
  20. package/dist/esm/models/GetDispatchCourse.js +77 -0
  21. package/dist/esm/models/GetDispatchRollup.d.ts +104 -0
  22. package/dist/esm/models/GetDispatchRollup.js +95 -0
  23. package/dist/esm/models/GetHostedScormRegistration.d.ts +80 -0
  24. package/dist/esm/models/GetHostedScormRegistration.js +71 -0
  25. package/dist/esm/models/GetHostedScormRegistrationList.d.ts +57 -0
  26. package/dist/esm/models/GetHostedScormRegistrationList.js +60 -0
  27. package/dist/esm/models/GetResourceSessionDiagnostics.d.ts +8 -0
  28. package/dist/esm/models/GetResourceSessionDiagnostics.js +2 -0
  29. package/dist/esm/models/HostedScormAccessPolicy.d.ts +50 -0
  30. package/dist/esm/models/HostedScormAccessPolicy.js +55 -0
  31. package/dist/esm/models/HostedScormOutlineEntry.d.ts +108 -0
  32. package/dist/esm/models/HostedScormOutlineEntry.js +97 -0
  33. package/dist/esm/models/HostedScormRollupPolicy.d.ts +69 -0
  34. package/dist/esm/models/HostedScormRollupPolicy.js +72 -0
  35. package/dist/esm/models/HostedScormScoreItem.d.ts +38 -0
  36. package/dist/esm/models/HostedScormScoreItem.js +47 -0
  37. package/dist/esm/models/PostCourseExport.d.ts +28 -0
  38. package/dist/esm/models/PostCourseExport.js +15 -0
  39. package/dist/esm/models/PostDispatchItemLaunch.d.ts +32 -0
  40. package/dist/esm/models/PostDispatchItemLaunch.js +41 -0
  41. package/dist/esm/models/PostDispatchItemLaunchResponse.d.ts +64 -0
  42. package/dist/esm/models/PostDispatchItemLaunchResponse.js +66 -0
  43. package/dist/esm/models/PostDispatchLaunch.d.ts +50 -0
  44. package/dist/esm/models/PostDispatchLaunch.js +53 -0
  45. package/dist/esm/models/PostDispatchLaunchResponse.d.ts +70 -0
  46. package/dist/esm/models/PostDispatchLaunchResponse.js +70 -0
  47. package/dist/esm/models/PostDispatchTokenExchange.d.ts +32 -0
  48. package/dist/esm/models/PostDispatchTokenExchange.js +43 -0
  49. package/dist/esm/models/PutHostedScormStatus.d.ts +32 -0
  50. package/dist/esm/models/PutHostedScormStatus.js +43 -0
  51. package/dist/esm/models/ScormGetValueResponse.d.ts +12 -0
  52. package/dist/esm/models/ScormGetValueResponse.js +8 -0
  53. package/dist/esm/models/ScormNavigationDelivery.d.ts +64 -0
  54. package/dist/esm/models/ScormNavigationDelivery.js +66 -0
  55. package/dist/esm/models/ScormNavigationRequest.d.ts +55 -0
  56. package/dist/esm/models/ScormNavigationRequest.js +61 -0
  57. package/dist/esm/models/ScormNavigationResponse.d.ts +70 -0
  58. package/dist/esm/models/ScormNavigationResponse.js +67 -0
  59. package/dist/esm/models/ScormNavigationValidity.d.ts +92 -0
  60. package/dist/esm/models/ScormNavigationValidity.js +83 -0
  61. package/dist/esm/models/ScormRuntimeResponse.d.ts +44 -0
  62. package/dist/esm/models/ScormRuntimeResponse.js +51 -0
  63. package/dist/esm/models/ScormSetValueResponse.d.ts +12 -0
  64. package/dist/esm/models/ScormSetValueResponse.js +8 -0
  65. package/dist/esm/models/ScormTerminateResponse.d.ts +63 -0
  66. package/dist/esm/models/ScormTerminateResponse.js +62 -0
  67. package/dist/esm/models/index.d.ts +21 -0
  68. package/dist/esm/models/index.js +21 -0
  69. package/dist/models/DispatchTokenResponse.d.ts +57 -0
  70. package/dist/models/DispatchTokenResponse.js +69 -0
  71. package/dist/models/GetCourseExport.d.ts +62 -0
  72. package/dist/models/GetCourseExport.js +45 -1
  73. package/dist/models/GetDispatchCourse.d.ts +82 -0
  74. package/dist/models/GetDispatchCourse.js +84 -0
  75. package/dist/models/GetDispatchRollup.d.ts +104 -0
  76. package/dist/models/GetDispatchRollup.js +103 -0
  77. package/dist/models/GetHostedScormRegistration.d.ts +80 -0
  78. package/dist/models/GetHostedScormRegistration.js +78 -0
  79. package/dist/models/GetHostedScormRegistrationList.d.ts +57 -0
  80. package/dist/models/GetHostedScormRegistrationList.js +67 -0
  81. package/dist/models/GetResourceSessionDiagnostics.d.ts +8 -0
  82. package/dist/models/GetResourceSessionDiagnostics.js +2 -0
  83. package/dist/models/HostedScormAccessPolicy.d.ts +50 -0
  84. package/dist/models/HostedScormAccessPolicy.js +62 -0
  85. package/dist/models/HostedScormOutlineEntry.d.ts +108 -0
  86. package/dist/models/HostedScormOutlineEntry.js +105 -0
  87. package/dist/models/HostedScormRollupPolicy.d.ts +69 -0
  88. package/dist/models/HostedScormRollupPolicy.js +80 -0
  89. package/dist/models/HostedScormScoreItem.d.ts +38 -0
  90. package/dist/models/HostedScormScoreItem.js +54 -0
  91. package/dist/models/PostCourseExport.d.ts +28 -0
  92. package/dist/models/PostCourseExport.js +16 -1
  93. package/dist/models/PostDispatchItemLaunch.d.ts +32 -0
  94. package/dist/models/PostDispatchItemLaunch.js +48 -0
  95. package/dist/models/PostDispatchItemLaunchResponse.d.ts +64 -0
  96. package/dist/models/PostDispatchItemLaunchResponse.js +74 -0
  97. package/dist/models/PostDispatchLaunch.d.ts +50 -0
  98. package/dist/models/PostDispatchLaunch.js +60 -0
  99. package/dist/models/PostDispatchLaunchResponse.d.ts +70 -0
  100. package/dist/models/PostDispatchLaunchResponse.js +78 -0
  101. package/dist/models/PostDispatchTokenExchange.d.ts +32 -0
  102. package/dist/models/PostDispatchTokenExchange.js +50 -0
  103. package/dist/models/PutHostedScormStatus.d.ts +32 -0
  104. package/dist/models/PutHostedScormStatus.js +50 -0
  105. package/dist/models/ScormGetValueResponse.d.ts +12 -0
  106. package/dist/models/ScormGetValueResponse.js +8 -0
  107. package/dist/models/ScormNavigationDelivery.d.ts +64 -0
  108. package/dist/models/ScormNavigationDelivery.js +74 -0
  109. package/dist/models/ScormNavigationRequest.d.ts +55 -0
  110. package/dist/models/ScormNavigationRequest.js +69 -0
  111. package/dist/models/ScormNavigationResponse.d.ts +70 -0
  112. package/dist/models/ScormNavigationResponse.js +74 -0
  113. package/dist/models/ScormNavigationValidity.d.ts +92 -0
  114. package/dist/models/ScormNavigationValidity.js +90 -0
  115. package/dist/models/ScormRuntimeResponse.d.ts +44 -0
  116. package/dist/models/ScormRuntimeResponse.js +58 -0
  117. package/dist/models/ScormSetValueResponse.d.ts +12 -0
  118. package/dist/models/ScormSetValueResponse.js +8 -0
  119. package/dist/models/ScormTerminateResponse.d.ts +63 -0
  120. package/dist/models/ScormTerminateResponse.js +69 -0
  121. package/dist/models/index.d.ts +21 -0
  122. package/dist/models/index.js +21 -0
  123. package/docs/CourseApi.md +225 -0
  124. package/docs/DispatchApi.md +480 -9
  125. package/docs/DispatchTokenResponse.md +40 -0
  126. package/docs/GetCourseExport.md +14 -0
  127. package/docs/GetDispatchCourse.md +50 -0
  128. package/docs/GetDispatchRollup.md +52 -0
  129. package/docs/GetHostedScormRegistration.md +50 -0
  130. package/docs/GetHostedScormRegistrationList.md +42 -0
  131. package/docs/GetResourceSessionDiagnostics.md +2 -0
  132. package/docs/HostedScormAccessPolicy.md +41 -0
  133. package/docs/HostedScormOutlineEntry.md +54 -0
  134. package/docs/HostedScormRollupPolicy.md +41 -0
  135. package/docs/HostedScormScoreItem.md +36 -0
  136. package/docs/PlayerApi.md +80 -9
  137. package/docs/PostCourseExport.md +6 -0
  138. package/docs/PostDispatchItemLaunch.md +34 -0
  139. package/docs/PostDispatchItemLaunchResponse.md +42 -0
  140. package/docs/PostDispatchLaunch.md +40 -0
  141. package/docs/PostDispatchLaunchResponse.md +44 -0
  142. package/docs/PostDispatchTokenExchange.md +34 -0
  143. package/docs/PutHostedScormStatus.md +34 -0
  144. package/docs/ScormGetValueResponse.md +4 -0
  145. package/docs/ScormNavigationDelivery.md +43 -0
  146. package/docs/ScormNavigationRequest.md +37 -0
  147. package/docs/ScormNavigationResponse.md +47 -0
  148. package/docs/ScormNavigationValidity.md +55 -0
  149. package/docs/ScormRuntimeResponse.md +39 -0
  150. package/docs/ScormSetValueResponse.md +4 -0
  151. package/docs/ScormTerminateResponse.md +44 -0
  152. package/package.json +1 -1
  153. package/src/apis/CourseApi.ts +221 -0
  154. package/src/apis/DispatchApi.ts +426 -10
  155. package/src/apis/PlayerApi.ts +95 -12
  156. package/src/models/DispatchTokenResponse.ts +103 -0
  157. package/src/models/GetCourseExport.ts +97 -0
  158. package/src/models/GetDispatchCourse.ts +153 -0
  159. package/src/models/GetDispatchRollup.ts +169 -0
  160. package/src/models/GetHostedScormRegistration.ts +136 -0
  161. package/src/models/GetHostedScormRegistrationList.ts +110 -0
  162. package/src/models/GetResourceSessionDiagnostics.ts +8 -0
  163. package/src/models/HostedScormAccessPolicy.ts +93 -0
  164. package/src/models/HostedScormOutlineEntry.ts +176 -0
  165. package/src/models/HostedScormRollupPolicy.ts +123 -0
  166. package/src/models/HostedScormScoreItem.ts +75 -0
  167. package/src/models/PostCourseExport.ts +48 -0
  168. package/src/models/PostDispatchItemLaunch.ts +65 -0
  169. package/src/models/PostDispatchItemLaunchResponse.ts +113 -0
  170. package/src/models/PostDispatchLaunch.ts +92 -0
  171. package/src/models/PostDispatchLaunchResponse.ts +122 -0
  172. package/src/models/PostDispatchTokenExchange.ts +66 -0
  173. package/src/models/PutHostedScormStatus.ts +66 -0
  174. package/src/models/ScormGetValueResponse.ts +18 -0
  175. package/src/models/ScormNavigationDelivery.ts +113 -0
  176. package/src/models/ScormNavigationRequest.ts +94 -0
  177. package/src/models/ScormNavigationResponse.ts +134 -0
  178. package/src/models/ScormNavigationValidity.ts +156 -0
  179. package/src/models/ScormRuntimeResponse.ts +84 -0
  180. package/src/models/ScormSetValueResponse.ts +18 -0
  181. package/src/models/ScormTerminateResponse.ts +118 -0
  182. package/src/models/index.ts +21 -0
@@ -35,8 +35,12 @@ const GetResourceSessionScormData_1 = require("../models/GetResourceSessionScorm
35
35
  const PostResourceSessionActivityEvent_1 = require("../models/PostResourceSessionActivityEvent");
36
36
  const PutResourceSessionOverride_1 = require("../models/PutResourceSessionOverride");
37
37
  const ScormGetValueResponse_1 = require("../models/ScormGetValueResponse");
38
+ const ScormNavigationRequest_1 = require("../models/ScormNavigationRequest");
39
+ const ScormNavigationResponse_1 = require("../models/ScormNavigationResponse");
40
+ const ScormRuntimeResponse_1 = require("../models/ScormRuntimeResponse");
38
41
  const ScormSetValueRequest_1 = require("../models/ScormSetValueRequest");
39
42
  const ScormSetValueResponse_1 = require("../models/ScormSetValueResponse");
43
+ const ScormTerminateResponse_1 = require("../models/ScormTerminateResponse");
40
44
  /**
41
45
  *
42
46
  */
@@ -71,7 +75,7 @@ class PlayerApi extends runtime.BaseAPI {
71
75
  return __awaiter(this, void 0, void 0, function* () {
72
76
  const requestOptions = yield this.commitResourceScormSessionRequestOpts(requestParameters);
73
77
  const response = yield this.request(requestOptions, initOverrides);
74
- return new runtime.VoidApiResponse(response);
78
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, ScormRuntimeResponse_1.ScormRuntimeResponseFromJSON)(jsonValue));
75
79
  });
76
80
  }
77
81
  /**
@@ -79,7 +83,8 @@ class PlayerApi extends runtime.BaseAPI {
79
83
  */
80
84
  commitResourceScormSession(requestParameters, initOverrides) {
81
85
  return __awaiter(this, void 0, void 0, function* () {
82
- yield this.commitResourceScormSessionRaw(requestParameters, initOverrides);
86
+ const response = yield this.commitResourceScormSessionRaw(requestParameters, initOverrides);
87
+ return yield response.value();
83
88
  });
84
89
  }
85
90
  /**
@@ -688,7 +693,7 @@ class PlayerApi extends runtime.BaseAPI {
688
693
  return __awaiter(this, void 0, void 0, function* () {
689
694
  const requestOptions = yield this.initializeResourceScormSessionRequestOpts(requestParameters);
690
695
  const response = yield this.request(requestOptions, initOverrides);
691
- return new runtime.VoidApiResponse(response);
696
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, ScormRuntimeResponse_1.ScormRuntimeResponseFromJSON)(jsonValue));
692
697
  });
693
698
  }
694
699
  /**
@@ -696,7 +701,52 @@ class PlayerApi extends runtime.BaseAPI {
696
701
  */
697
702
  initializeResourceScormSession(requestParameters, initOverrides) {
698
703
  return __awaiter(this, void 0, void 0, function* () {
699
- yield this.initializeResourceScormSessionRaw(requestParameters, initOverrides);
704
+ const response = yield this.initializeResourceScormSessionRaw(requestParameters, initOverrides);
705
+ return yield response.value();
706
+ });
707
+ }
708
+ /**
709
+ * Creates request options for navigateResourceScormSession without sending the request
710
+ */
711
+ navigateResourceScormSessionRequestOpts(requestParameters) {
712
+ return __awaiter(this, void 0, void 0, function* () {
713
+ if (requestParameters['sessionId'] == null) {
714
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling navigateResourceScormSession().');
715
+ }
716
+ if (requestParameters['scormNavigationRequest'] == null) {
717
+ throw new runtime.RequiredError('scormNavigationRequest', 'Required parameter "scormNavigationRequest" was null or undefined when calling navigateResourceScormSession().');
718
+ }
719
+ const queryParameters = {};
720
+ const headerParameters = {};
721
+ headerParameters['Content-Type'] = 'application/json';
722
+ let urlPath = `/resource/sessions/{sessionId}/navigation`;
723
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
724
+ return {
725
+ path: urlPath,
726
+ method: 'POST',
727
+ headers: headerParameters,
728
+ query: queryParameters,
729
+ body: (0, ScormNavigationRequest_1.ScormNavigationRequestToJSON)(requestParameters['scormNavigationRequest']),
730
+ };
731
+ });
732
+ }
733
+ /**
734
+ * Process a SCORM 2004 sequencing and navigation request
735
+ */
736
+ navigateResourceScormSessionRaw(requestParameters, initOverrides) {
737
+ return __awaiter(this, void 0, void 0, function* () {
738
+ const requestOptions = yield this.navigateResourceScormSessionRequestOpts(requestParameters);
739
+ const response = yield this.request(requestOptions, initOverrides);
740
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, ScormNavigationResponse_1.ScormNavigationResponseFromJSON)(jsonValue));
741
+ });
742
+ }
743
+ /**
744
+ * Process a SCORM 2004 sequencing and navigation request
745
+ */
746
+ navigateResourceScormSession(requestParameters, initOverrides) {
747
+ return __awaiter(this, void 0, void 0, function* () {
748
+ const response = yield this.navigateResourceScormSessionRaw(requestParameters, initOverrides);
749
+ return yield response.value();
700
750
  });
701
751
  }
702
752
  /**
@@ -907,7 +957,7 @@ class PlayerApi extends runtime.BaseAPI {
907
957
  return __awaiter(this, void 0, void 0, function* () {
908
958
  const requestOptions = yield this.terminateResourceScormSessionRequestOpts(requestParameters);
909
959
  const response = yield this.request(requestOptions, initOverrides);
910
- return new runtime.VoidApiResponse(response);
960
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, ScormTerminateResponse_1.ScormTerminateResponseFromJSON)(jsonValue));
911
961
  });
912
962
  }
913
963
  /**
@@ -915,7 +965,8 @@ class PlayerApi extends runtime.BaseAPI {
915
965
  */
916
966
  terminateResourceScormSession(requestParameters, initOverrides) {
917
967
  return __awaiter(this, void 0, void 0, function* () {
918
- yield this.terminateResourceScormSessionRaw(requestParameters, initOverrides);
968
+ const response = yield this.terminateResourceScormSessionRaw(requestParameters, initOverrides);
969
+ return yield response.value();
919
970
  });
920
971
  }
921
972
  }
@@ -25,6 +25,8 @@ import { type GetCourseVersionItemSession } from '../models/GetCourseVersionItem
25
25
  import { type GetCourseVersionList } from '../models/GetCourseVersionList';
26
26
  import { type GetCourseVersionProgression } from '../models/GetCourseVersionProgression';
27
27
  import { type GetCourseVersionSection } from '../models/GetCourseVersionSection';
28
+ import { type GetHostedScormRegistrationList } from '../models/GetHostedScormRegistrationList';
29
+ import { type HostedScormAccessPolicy } from '../models/HostedScormAccessPolicy';
28
30
  import { type PostClearSessions } from '../models/PostClearSessions';
29
31
  import { type PostClearSessionsResponse } from '../models/PostClearSessionsResponse';
30
32
  import { type PostCourse } from '../models/PostCourse';
@@ -45,6 +47,7 @@ import { type PutCourseVersionDraft } from '../models/PutCourseVersionDraft';
45
47
  import { type PutCourseVersionItem } from '../models/PutCourseVersionItem';
46
48
  import { type PutCourseVersionOutlineEntryMove } from '../models/PutCourseVersionOutlineEntryMove';
47
49
  import { type PutCourseVersionSection } from '../models/PutCourseVersionSection';
50
+ import { type PutHostedScormStatus } from '../models/PutHostedScormStatus';
48
51
  export interface DeleteCourseRequest {
49
52
  courseId: string;
50
53
  }
@@ -131,6 +134,12 @@ export interface GetCourseVersionProgressionRequest {
131
134
  courseVersionId: string;
132
135
  preview?: boolean;
133
136
  }
137
+ export interface GetHostedScormExportRegistrationsRequest {
138
+ courseId: string;
139
+ exportId: string;
140
+ page?: number;
141
+ pageSize?: number;
142
+ }
134
143
  export interface GetPortalCourseExportsRequest {
135
144
  page?: number;
136
145
  pageSize?: number;
@@ -234,6 +243,16 @@ export interface PutCourseVersionSectionRequest {
234
243
  sectionId: string;
235
244
  putCourseVersionSection: PutCourseVersionSection;
236
245
  }
246
+ export interface PutHostedScormExportAccessRequest {
247
+ courseId: string;
248
+ exportId: string;
249
+ hostedScormAccessPolicy: HostedScormAccessPolicy;
250
+ }
251
+ export interface PutHostedScormExportStatusRequest {
252
+ courseId: string;
253
+ exportId: string;
254
+ putHostedScormStatus: PutHostedScormStatus;
255
+ }
237
256
  /**
238
257
  *
239
258
  */
@@ -468,6 +487,18 @@ export declare class CourseApi extends runtime.BaseAPI {
468
487
  * Get learner-specific completion and section lock state
469
488
  */
470
489
  getCourseVersionProgression(requestParameters: GetCourseVersionProgressionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionProgression>;
490
+ /**
491
+ * Creates request options for getHostedScormExportRegistrations without sending the request
492
+ */
493
+ getHostedScormExportRegistrationsRequestOpts(requestParameters: GetHostedScormExportRegistrationsRequest): Promise<runtime.RequestOpts>;
494
+ /**
495
+ * List hosted SCORM learner registrations
496
+ */
497
+ getHostedScormExportRegistrationsRaw(requestParameters: GetHostedScormExportRegistrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetHostedScormRegistrationList>>;
498
+ /**
499
+ * List hosted SCORM learner registrations
500
+ */
501
+ getHostedScormExportRegistrations(requestParameters: GetHostedScormExportRegistrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetHostedScormRegistrationList>;
471
502
  /**
472
503
  * Creates request options for getPortalCourseExports without sending the request
473
504
  */
@@ -738,6 +769,30 @@ export declare class CourseApi extends runtime.BaseAPI {
738
769
  * Update a draft section
739
770
  */
740
771
  putCourseVersionSection(requestParameters: PutCourseVersionSectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseVersionSection>;
772
+ /**
773
+ * Creates request options for putHostedScormExportAccess without sending the request
774
+ */
775
+ putHostedScormExportAccessRequestOpts(requestParameters: PutHostedScormExportAccessRequest): Promise<runtime.RequestOpts>;
776
+ /**
777
+ * Update mutable access controls for a hosted SCORM export
778
+ */
779
+ putHostedScormExportAccessRaw(requestParameters: PutHostedScormExportAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExport>>;
780
+ /**
781
+ * Update mutable access controls for a hosted SCORM export
782
+ */
783
+ putHostedScormExportAccess(requestParameters: PutHostedScormExportAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExport>;
784
+ /**
785
+ * Creates request options for putHostedScormExportStatus without sending the request
786
+ */
787
+ putHostedScormExportStatusRequestOpts(requestParameters: PutHostedScormExportStatusRequest): Promise<runtime.RequestOpts>;
788
+ /**
789
+ * Revoke or reactivate a hosted SCORM export
790
+ */
791
+ putHostedScormExportStatusRaw(requestParameters: PutHostedScormExportStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExport>>;
792
+ /**
793
+ * Revoke or reactivate a hosted SCORM export
794
+ */
795
+ putHostedScormExportStatus(requestParameters: PutHostedScormExportStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExport>;
741
796
  }
742
797
  /**
743
798
  * @export
@@ -36,6 +36,8 @@ import { GetCourseVersionItemSessionFromJSON, } from '../models/GetCourseVersion
36
36
  import { GetCourseVersionListFromJSON, } from '../models/GetCourseVersionList';
37
37
  import { GetCourseVersionProgressionFromJSON, } from '../models/GetCourseVersionProgression';
38
38
  import { GetCourseVersionSectionFromJSON, } from '../models/GetCourseVersionSection';
39
+ import { GetHostedScormRegistrationListFromJSON, } from '../models/GetHostedScormRegistrationList';
40
+ import { HostedScormAccessPolicyToJSON, } from '../models/HostedScormAccessPolicy';
39
41
  import { PostClearSessionsToJSON, } from '../models/PostClearSessions';
40
42
  import { PostClearSessionsResponseFromJSON, } from '../models/PostClearSessionsResponse';
41
43
  import { PostCourseToJSON, } from '../models/PostCourse';
@@ -56,6 +58,7 @@ import { PutCourseVersionDraftToJSON, } from '../models/PutCourseVersionDraft';
56
58
  import { PutCourseVersionItemToJSON, } from '../models/PutCourseVersionItem';
57
59
  import { PutCourseVersionOutlineEntryMoveToJSON, } from '../models/PutCourseVersionOutlineEntryMove';
58
60
  import { PutCourseVersionSectionToJSON, } from '../models/PutCourseVersionSection';
61
+ import { PutHostedScormStatusToJSON, } from '../models/PutHostedScormStatus';
59
62
  /**
60
63
  *
61
64
  */
@@ -898,6 +901,55 @@ export class CourseApi extends runtime.BaseAPI {
898
901
  return yield response.value();
899
902
  });
900
903
  }
904
+ /**
905
+ * Creates request options for getHostedScormExportRegistrations without sending the request
906
+ */
907
+ getHostedScormExportRegistrationsRequestOpts(requestParameters) {
908
+ return __awaiter(this, void 0, void 0, function* () {
909
+ if (requestParameters['courseId'] == null) {
910
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling getHostedScormExportRegistrations().');
911
+ }
912
+ if (requestParameters['exportId'] == null) {
913
+ throw new runtime.RequiredError('exportId', 'Required parameter "exportId" was null or undefined when calling getHostedScormExportRegistrations().');
914
+ }
915
+ const queryParameters = {};
916
+ if (requestParameters['page'] != null) {
917
+ queryParameters['page'] = requestParameters['page'];
918
+ }
919
+ if (requestParameters['pageSize'] != null) {
920
+ queryParameters['page_size'] = requestParameters['pageSize'];
921
+ }
922
+ const headerParameters = {};
923
+ let urlPath = `/courses/{courseId}/exports/{exportId}/registrations`;
924
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
925
+ urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
926
+ return {
927
+ path: urlPath,
928
+ method: 'GET',
929
+ headers: headerParameters,
930
+ query: queryParameters,
931
+ };
932
+ });
933
+ }
934
+ /**
935
+ * List hosted SCORM learner registrations
936
+ */
937
+ getHostedScormExportRegistrationsRaw(requestParameters, initOverrides) {
938
+ return __awaiter(this, void 0, void 0, function* () {
939
+ const requestOptions = yield this.getHostedScormExportRegistrationsRequestOpts(requestParameters);
940
+ const response = yield this.request(requestOptions, initOverrides);
941
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetHostedScormRegistrationListFromJSON(jsonValue));
942
+ });
943
+ }
944
+ /**
945
+ * List hosted SCORM learner registrations
946
+ */
947
+ getHostedScormExportRegistrations(requestParameters, initOverrides) {
948
+ return __awaiter(this, void 0, void 0, function* () {
949
+ const response = yield this.getHostedScormExportRegistrationsRaw(requestParameters, initOverrides);
950
+ return yield response.value();
951
+ });
952
+ }
901
953
  /**
902
954
  * Creates request options for getPortalCourseExports without sending the request
903
955
  */
@@ -1933,6 +1985,102 @@ export class CourseApi extends runtime.BaseAPI {
1933
1985
  return yield response.value();
1934
1986
  });
1935
1987
  }
1988
+ /**
1989
+ * Creates request options for putHostedScormExportAccess without sending the request
1990
+ */
1991
+ putHostedScormExportAccessRequestOpts(requestParameters) {
1992
+ return __awaiter(this, void 0, void 0, function* () {
1993
+ if (requestParameters['courseId'] == null) {
1994
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling putHostedScormExportAccess().');
1995
+ }
1996
+ if (requestParameters['exportId'] == null) {
1997
+ throw new runtime.RequiredError('exportId', 'Required parameter "exportId" was null or undefined when calling putHostedScormExportAccess().');
1998
+ }
1999
+ if (requestParameters['hostedScormAccessPolicy'] == null) {
2000
+ throw new runtime.RequiredError('hostedScormAccessPolicy', 'Required parameter "hostedScormAccessPolicy" was null or undefined when calling putHostedScormExportAccess().');
2001
+ }
2002
+ const queryParameters = {};
2003
+ const headerParameters = {};
2004
+ headerParameters['Content-Type'] = 'application/json';
2005
+ let urlPath = `/courses/{courseId}/exports/{exportId}/access`;
2006
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
2007
+ urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
2008
+ return {
2009
+ path: urlPath,
2010
+ method: 'PUT',
2011
+ headers: headerParameters,
2012
+ query: queryParameters,
2013
+ body: HostedScormAccessPolicyToJSON(requestParameters['hostedScormAccessPolicy']),
2014
+ };
2015
+ });
2016
+ }
2017
+ /**
2018
+ * Update mutable access controls for a hosted SCORM export
2019
+ */
2020
+ putHostedScormExportAccessRaw(requestParameters, initOverrides) {
2021
+ return __awaiter(this, void 0, void 0, function* () {
2022
+ const requestOptions = yield this.putHostedScormExportAccessRequestOpts(requestParameters);
2023
+ const response = yield this.request(requestOptions, initOverrides);
2024
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseExportFromJSON(jsonValue));
2025
+ });
2026
+ }
2027
+ /**
2028
+ * Update mutable access controls for a hosted SCORM export
2029
+ */
2030
+ putHostedScormExportAccess(requestParameters, initOverrides) {
2031
+ return __awaiter(this, void 0, void 0, function* () {
2032
+ const response = yield this.putHostedScormExportAccessRaw(requestParameters, initOverrides);
2033
+ return yield response.value();
2034
+ });
2035
+ }
2036
+ /**
2037
+ * Creates request options for putHostedScormExportStatus without sending the request
2038
+ */
2039
+ putHostedScormExportStatusRequestOpts(requestParameters) {
2040
+ return __awaiter(this, void 0, void 0, function* () {
2041
+ if (requestParameters['courseId'] == null) {
2042
+ throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling putHostedScormExportStatus().');
2043
+ }
2044
+ if (requestParameters['exportId'] == null) {
2045
+ throw new runtime.RequiredError('exportId', 'Required parameter "exportId" was null or undefined when calling putHostedScormExportStatus().');
2046
+ }
2047
+ if (requestParameters['putHostedScormStatus'] == null) {
2048
+ throw new runtime.RequiredError('putHostedScormStatus', 'Required parameter "putHostedScormStatus" was null or undefined when calling putHostedScormExportStatus().');
2049
+ }
2050
+ const queryParameters = {};
2051
+ const headerParameters = {};
2052
+ headerParameters['Content-Type'] = 'application/json';
2053
+ let urlPath = `/courses/{courseId}/exports/{exportId}/status`;
2054
+ urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
2055
+ urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
2056
+ return {
2057
+ path: urlPath,
2058
+ method: 'PUT',
2059
+ headers: headerParameters,
2060
+ query: queryParameters,
2061
+ body: PutHostedScormStatusToJSON(requestParameters['putHostedScormStatus']),
2062
+ };
2063
+ });
2064
+ }
2065
+ /**
2066
+ * Revoke or reactivate a hosted SCORM export
2067
+ */
2068
+ putHostedScormExportStatusRaw(requestParameters, initOverrides) {
2069
+ return __awaiter(this, void 0, void 0, function* () {
2070
+ const requestOptions = yield this.putHostedScormExportStatusRequestOpts(requestParameters);
2071
+ const response = yield this.request(requestOptions, initOverrides);
2072
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseExportFromJSON(jsonValue));
2073
+ });
2074
+ }
2075
+ /**
2076
+ * Revoke or reactivate a hosted SCORM export
2077
+ */
2078
+ putHostedScormExportStatus(requestParameters, initOverrides) {
2079
+ return __awaiter(this, void 0, void 0, function* () {
2080
+ const response = yield this.putHostedScormExportStatusRaw(requestParameters, initOverrides);
2081
+ return yield response.value();
2082
+ });
2083
+ }
1936
2084
  }
1937
2085
  /**
1938
2086
  * @export
@@ -10,13 +10,69 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
+ import { type DispatchTokenResponse } from '../models/DispatchTokenResponse';
14
+ import { type GetDispatchCourse } from '../models/GetDispatchCourse';
15
+ import { type GetDispatchRollup } from '../models/GetDispatchRollup';
16
+ import { type GetLibraryQuizResult } from '../models/GetLibraryQuizResult';
17
+ import { type GetLibraryQuizSession } from '../models/GetLibraryQuizSession';
18
+ import { type PostDispatchItemLaunch } from '../models/PostDispatchItemLaunch';
19
+ import { type PostDispatchItemLaunchResponse } from '../models/PostDispatchItemLaunchResponse';
20
+ import { type PostDispatchLaunch } from '../models/PostDispatchLaunch';
21
+ import { type PostDispatchLaunchResponse } from '../models/PostDispatchLaunchResponse';
22
+ import { type PostDispatchTokenExchange } from '../models/PostDispatchTokenExchange';
23
+ import { type PutLibraryQuizSessionAnswer } from '../models/PutLibraryQuizSessionAnswer';
24
+ export interface GetDispatchQuizSessionRequest {
25
+ sessionId: string;
26
+ }
13
27
  export interface GetDispatchRollupRequest {
14
28
  dispatchPackageId: string;
15
29
  }
30
+ export interface PostDispatchItemLaunchRequest {
31
+ itemId: string;
32
+ postDispatchItemLaunch?: PostDispatchItemLaunch;
33
+ }
34
+ export interface PostDispatchLaunchRequest {
35
+ postDispatchLaunch: PostDispatchLaunch;
36
+ }
37
+ export interface PostDispatchQuizSessionSubmitRequest {
38
+ sessionId: string;
39
+ }
40
+ export interface PostDispatchTokenExchangeRequest {
41
+ postDispatchTokenExchange: PostDispatchTokenExchange;
42
+ }
43
+ export interface PutDispatchQuizSessionAnswerRequest {
44
+ sessionId: string;
45
+ sessionQuestionId: string;
46
+ putLibraryQuizSessionAnswer: PutLibraryQuizSessionAnswer;
47
+ }
16
48
  /**
17
49
  *
18
50
  */
19
51
  export declare class DispatchApi extends runtime.BaseAPI {
52
+ /**
53
+ * Creates request options for getDispatchCourse without sending the request
54
+ */
55
+ getDispatchCourseRequestOpts(): Promise<runtime.RequestOpts>;
56
+ /**
57
+ * Get the registration-scoped hosted course snapshot
58
+ */
59
+ getDispatchCourseRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDispatchCourse>>;
60
+ /**
61
+ * Get the registration-scoped hosted course snapshot
62
+ */
63
+ getDispatchCourse(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDispatchCourse>;
64
+ /**
65
+ * Creates request options for getDispatchQuizSession without sending the request
66
+ */
67
+ getDispatchQuizSessionRequestOpts(requestParameters: GetDispatchQuizSessionRequest): Promise<runtime.RequestOpts>;
68
+ /**
69
+ * Get a registration-owned native quiz session
70
+ */
71
+ getDispatchQuizSessionRaw(requestParameters: GetDispatchQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLibraryQuizSession>>;
72
+ /**
73
+ * Get a registration-owned native quiz session
74
+ */
75
+ getDispatchQuizSession(requestParameters: GetDispatchQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLibraryQuizSession>;
20
76
  /**
21
77
  * Creates request options for getDispatchRollup without sending the request
22
78
  */
@@ -24,21 +80,81 @@ export declare class DispatchApi extends runtime.BaseAPI {
24
80
  /**
25
81
  * Get dispatch package rollup data
26
82
  */
27
- getDispatchRollupRaw(requestParameters: GetDispatchRollupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
83
+ getDispatchRollupRaw(requestParameters: GetDispatchRollupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDispatchRollup>>;
28
84
  /**
29
85
  * Get dispatch package rollup data
30
86
  */
31
- getDispatchRollup(requestParameters: GetDispatchRollupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
87
+ getDispatchRollup(requestParameters: GetDispatchRollupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDispatchRollup>;
88
+ /**
89
+ * Creates request options for postDispatchItemLaunch without sending the request
90
+ */
91
+ postDispatchItemLaunchRequestOpts(requestParameters: PostDispatchItemLaunchRequest): Promise<runtime.RequestOpts>;
92
+ /**
93
+ * Start or resume a selected hosted course item
94
+ */
95
+ postDispatchItemLaunchRaw(requestParameters: PostDispatchItemLaunchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostDispatchItemLaunchResponse>>;
96
+ /**
97
+ * Start or resume a selected hosted course item
98
+ */
99
+ postDispatchItemLaunch(requestParameters: PostDispatchItemLaunchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostDispatchItemLaunchResponse>;
32
100
  /**
33
101
  * Creates request options for postDispatchLaunch without sending the request
34
102
  */
35
- postDispatchLaunchRequestOpts(): Promise<runtime.RequestOpts>;
103
+ postDispatchLaunchRequestOpts(requestParameters: PostDispatchLaunchRequest): Promise<runtime.RequestOpts>;
36
104
  /**
37
105
  * Launch a dispatch package
38
106
  */
39
- postDispatchLaunchRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
107
+ postDispatchLaunchRaw(requestParameters: PostDispatchLaunchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostDispatchLaunchResponse>>;
40
108
  /**
41
109
  * Launch a dispatch package
42
110
  */
43
- postDispatchLaunch(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
111
+ postDispatchLaunch(requestParameters: PostDispatchLaunchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostDispatchLaunchResponse>;
112
+ /**
113
+ * Creates request options for postDispatchQuizSessionSubmit without sending the request
114
+ */
115
+ postDispatchQuizSessionSubmitRequestOpts(requestParameters: PostDispatchQuizSessionSubmitRequest): Promise<runtime.RequestOpts>;
116
+ /**
117
+ * Submit a registration-owned native quiz session
118
+ */
119
+ postDispatchQuizSessionSubmitRaw(requestParameters: PostDispatchQuizSessionSubmitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLibraryQuizResult>>;
120
+ /**
121
+ * Submit a registration-owned native quiz session
122
+ */
123
+ postDispatchQuizSessionSubmit(requestParameters: PostDispatchQuizSessionSubmitRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLibraryQuizResult>;
124
+ /**
125
+ * Creates request options for postDispatchTokenExchange without sending the request
126
+ */
127
+ postDispatchTokenExchangeRequestOpts(requestParameters: PostDispatchTokenExchangeRequest): Promise<runtime.RequestOpts>;
128
+ /**
129
+ * Exchange a one-time hosted SCORM launch code
130
+ */
131
+ postDispatchTokenExchangeRaw(requestParameters: PostDispatchTokenExchangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DispatchTokenResponse>>;
132
+ /**
133
+ * Exchange a one-time hosted SCORM launch code
134
+ */
135
+ postDispatchTokenExchange(requestParameters: PostDispatchTokenExchangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DispatchTokenResponse>;
136
+ /**
137
+ * Creates request options for postDispatchTokenRefresh without sending the request
138
+ */
139
+ postDispatchTokenRefreshRequestOpts(): Promise<runtime.RequestOpts>;
140
+ /**
141
+ * Rotate a valid hosted SCORM access token
142
+ */
143
+ postDispatchTokenRefreshRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DispatchTokenResponse>>;
144
+ /**
145
+ * Rotate a valid hosted SCORM access token
146
+ */
147
+ postDispatchTokenRefresh(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DispatchTokenResponse>;
148
+ /**
149
+ * Creates request options for putDispatchQuizSessionAnswer without sending the request
150
+ */
151
+ putDispatchQuizSessionAnswerRequestOpts(requestParameters: PutDispatchQuizSessionAnswerRequest): Promise<runtime.RequestOpts>;
152
+ /**
153
+ * Save a registration-owned native quiz answer
154
+ */
155
+ putDispatchQuizSessionAnswerRaw(requestParameters: PutDispatchQuizSessionAnswerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLibraryQuizSession>>;
156
+ /**
157
+ * Save a registration-owned native quiz answer
158
+ */
159
+ putDispatchQuizSessionAnswer(requestParameters: PutDispatchQuizSessionAnswerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLibraryQuizSession>;
44
160
  }