@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.
- package/.openapi-generator/FILES +28 -0
- package/README.md +24 -2
- package/dist/apis/ContentLibraryApi.d.ts +19 -0
- package/dist/apis/ContentLibraryApi.js +47 -0
- package/dist/apis/PlayerApi.d.ts +187 -0
- package/dist/apis/PlayerApi.js +401 -1
- package/dist/esm/apis/ContentLibraryApi.d.ts +19 -0
- package/dist/esm/apis/ContentLibraryApi.js +47 -0
- package/dist/esm/apis/PlayerApi.d.ts +187 -0
- package/dist/esm/apis/PlayerApi.js +400 -0
- package/dist/esm/models/GetCourseVersionItemSession.d.ts +7 -0
- package/dist/esm/models/GetCourseVersionItemSession.js +5 -0
- package/dist/esm/models/GetResourceSession.d.ts +191 -0
- package/dist/esm/models/GetResourceSession.js +128 -0
- package/dist/esm/models/GetResourceSessionDiagnostics.d.ts +76 -0
- package/dist/esm/models/GetResourceSessionDiagnostics.js +69 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsCourseContext.d.ts +81 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsCourseContext.js +76 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsResource.d.ts +51 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsResource.js +56 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsScormSummary.d.ts +74 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsScormSummary.js +59 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsUser.d.ts +38 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsUser.js +47 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsVersion.d.ts +88 -0
- package/dist/esm/models/GetResourceSessionDiagnosticsVersion.js +67 -0
- package/dist/esm/models/GetResourceSessionList.d.ts +57 -0
- package/dist/esm/models/GetResourceSessionList.js +60 -0
- package/dist/esm/models/GetResourceSessionScormApiLogs.d.ts +57 -0
- package/dist/esm/models/GetResourceSessionScormApiLogs.js +60 -0
- package/dist/esm/models/GetResourceSessionScormData.d.ts +77 -0
- package/dist/esm/models/GetResourceSessionScormData.js +66 -0
- package/dist/esm/models/GetResourceSessionScormDataActivity.d.ts +44 -0
- package/dist/esm/models/GetResourceSessionScormDataActivity.js +45 -0
- package/dist/esm/models/PostResourceVersionSession.d.ts +32 -0
- package/dist/esm/models/PostResourceVersionSession.js +41 -0
- package/dist/esm/models/ResourceSessionEnvironment.d.ts +25 -0
- package/dist/esm/models/ResourceSessionEnvironment.js +43 -0
- package/dist/esm/models/ResourceSessionScormApiLogItem.d.ts +79 -0
- package/dist/esm/models/ResourceSessionScormApiLogItem.js +73 -0
- package/dist/esm/models/index.d.ts +14 -0
- package/dist/esm/models/index.js +14 -0
- package/dist/models/GetCourseVersionItemSession.d.ts +7 -0
- package/dist/models/GetCourseVersionItemSession.js +5 -0
- package/dist/models/GetResourceSession.d.ts +191 -0
- package/dist/models/GetResourceSession.js +135 -0
- package/dist/models/GetResourceSessionDiagnostics.d.ts +76 -0
- package/dist/models/GetResourceSessionDiagnostics.js +76 -0
- package/dist/models/GetResourceSessionDiagnosticsCourseContext.d.ts +81 -0
- package/dist/models/GetResourceSessionDiagnosticsCourseContext.js +83 -0
- package/dist/models/GetResourceSessionDiagnosticsResource.d.ts +51 -0
- package/dist/models/GetResourceSessionDiagnosticsResource.js +63 -0
- package/dist/models/GetResourceSessionDiagnosticsScormSummary.d.ts +74 -0
- package/dist/models/GetResourceSessionDiagnosticsScormSummary.js +66 -0
- package/dist/models/GetResourceSessionDiagnosticsUser.d.ts +38 -0
- package/dist/models/GetResourceSessionDiagnosticsUser.js +54 -0
- package/dist/models/GetResourceSessionDiagnosticsVersion.d.ts +88 -0
- package/dist/models/GetResourceSessionDiagnosticsVersion.js +74 -0
- package/dist/models/GetResourceSessionList.d.ts +57 -0
- package/dist/models/GetResourceSessionList.js +67 -0
- package/dist/models/GetResourceSessionScormApiLogs.d.ts +57 -0
- package/dist/models/GetResourceSessionScormApiLogs.js +67 -0
- package/dist/models/GetResourceSessionScormData.d.ts +77 -0
- package/dist/models/GetResourceSessionScormData.js +73 -0
- package/dist/models/GetResourceSessionScormDataActivity.d.ts +44 -0
- package/dist/models/GetResourceSessionScormDataActivity.js +52 -0
- package/dist/models/PostResourceVersionSession.d.ts +32 -0
- package/dist/models/PostResourceVersionSession.js +48 -0
- package/dist/models/ResourceSessionEnvironment.d.ts +25 -0
- package/dist/models/ResourceSessionEnvironment.js +51 -0
- package/dist/models/ResourceSessionScormApiLogItem.d.ts +79 -0
- package/dist/models/ResourceSessionScormApiLogItem.js +81 -0
- package/dist/models/index.d.ts +14 -0
- package/dist/models/index.js +14 -0
- package/docs/ContentLibraryApi.md +73 -0
- package/docs/GetCourseVersionItemSession.md +2 -0
- package/docs/GetResourceSession.md +87 -0
- package/docs/GetResourceSessionDiagnostics.md +47 -0
- package/docs/GetResourceSessionDiagnosticsCourseContext.md +50 -0
- package/docs/GetResourceSessionDiagnosticsResource.md +40 -0
- package/docs/GetResourceSessionDiagnosticsScormSummary.md +48 -0
- package/docs/GetResourceSessionDiagnosticsUser.md +36 -0
- package/docs/GetResourceSessionDiagnosticsVersion.md +52 -0
- package/docs/GetResourceSessionList.md +43 -0
- package/docs/GetResourceSessionScormApiLogs.md +43 -0
- package/docs/GetResourceSessionScormData.md +49 -0
- package/docs/GetResourceSessionScormDataActivity.md +38 -0
- package/docs/PlayerApi.md +547 -0
- package/docs/PostResourceVersionSession.md +35 -0
- package/docs/ResourceSessionEnvironment.md +33 -0
- package/docs/ResourceSessionScormApiLogItem.md +47 -0
- package/package.json +1 -1
- package/src/apis/ContentLibraryApi.ts +72 -0
- package/src/apis/PlayerApi.ts +558 -0
- package/src/models/GetCourseVersionItemSession.ts +16 -0
- package/src/models/GetResourceSession.ts +313 -0
- package/src/models/GetResourceSessionDiagnostics.ts +161 -0
- package/src/models/GetResourceSessionDiagnosticsCourseContext.ts +148 -0
- package/src/models/GetResourceSessionDiagnosticsResource.ts +103 -0
- package/src/models/GetResourceSessionDiagnosticsScormSummary.ts +123 -0
- package/src/models/GetResourceSessionDiagnosticsUser.ts +75 -0
- package/src/models/GetResourceSessionDiagnosticsVersion.ts +141 -0
- package/src/models/GetResourceSessionList.ts +110 -0
- package/src/models/GetResourceSessionScormApiLogs.ts +110 -0
- package/src/models/GetResourceSessionScormData.ts +134 -0
- package/src/models/GetResourceSessionScormDataActivity.ts +81 -0
- package/src/models/PostResourceVersionSession.ts +65 -0
- package/src/models/ResourceSessionEnvironment.ts +53 -0
- package/src/models/ResourceSessionScormApiLogItem.ts +132 -0
- package/src/models/index.ts +14 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -194,6 +194,17 @@ docs/GetQuizResultsTiming.md
|
|
|
194
194
|
docs/GetQuizStatistics.md
|
|
195
195
|
docs/GetResource.md
|
|
196
196
|
docs/GetResourceList.md
|
|
197
|
+
docs/GetResourceSession.md
|
|
198
|
+
docs/GetResourceSessionDiagnostics.md
|
|
199
|
+
docs/GetResourceSessionDiagnosticsCourseContext.md
|
|
200
|
+
docs/GetResourceSessionDiagnosticsResource.md
|
|
201
|
+
docs/GetResourceSessionDiagnosticsScormSummary.md
|
|
202
|
+
docs/GetResourceSessionDiagnosticsUser.md
|
|
203
|
+
docs/GetResourceSessionDiagnosticsVersion.md
|
|
204
|
+
docs/GetResourceSessionList.md
|
|
205
|
+
docs/GetResourceSessionScormApiLogs.md
|
|
206
|
+
docs/GetResourceSessionScormData.md
|
|
207
|
+
docs/GetResourceSessionScormDataActivity.md
|
|
197
208
|
docs/GetResourceUsage.md
|
|
198
209
|
docs/GetResourceUsageCoursesInner.md
|
|
199
210
|
docs/GetResourceVersionUpload.md
|
|
@@ -316,6 +327,7 @@ docs/PostResetPassword.md
|
|
|
316
327
|
docs/PostResource.md
|
|
317
328
|
docs/PostResourceVersion.md
|
|
318
329
|
docs/PostResourceVersionComplete.md
|
|
330
|
+
docs/PostResourceVersionSession.md
|
|
319
331
|
docs/PostResourceVersionUpload.md
|
|
320
332
|
docs/PostRevokeCertificate.md
|
|
321
333
|
docs/PostRichTextAssetComplete.md
|
|
@@ -370,6 +382,8 @@ docs/QuizContent.md
|
|
|
370
382
|
docs/QuizContentAssignment.md
|
|
371
383
|
docs/QuizContentSettings.md
|
|
372
384
|
docs/ReportingApi.md
|
|
385
|
+
docs/ResourceSessionEnvironment.md
|
|
386
|
+
docs/ResourceSessionScormApiLogItem.md
|
|
373
387
|
docs/ResourceType.md
|
|
374
388
|
docs/RichTextApi.md
|
|
375
389
|
docs/RichTextAsset.md
|
|
@@ -604,6 +618,17 @@ src/models/GetQuizResultsTiming.ts
|
|
|
604
618
|
src/models/GetQuizStatistics.ts
|
|
605
619
|
src/models/GetResource.ts
|
|
606
620
|
src/models/GetResourceList.ts
|
|
621
|
+
src/models/GetResourceSession.ts
|
|
622
|
+
src/models/GetResourceSessionDiagnostics.ts
|
|
623
|
+
src/models/GetResourceSessionDiagnosticsCourseContext.ts
|
|
624
|
+
src/models/GetResourceSessionDiagnosticsResource.ts
|
|
625
|
+
src/models/GetResourceSessionDiagnosticsScormSummary.ts
|
|
626
|
+
src/models/GetResourceSessionDiagnosticsUser.ts
|
|
627
|
+
src/models/GetResourceSessionDiagnosticsVersion.ts
|
|
628
|
+
src/models/GetResourceSessionList.ts
|
|
629
|
+
src/models/GetResourceSessionScormApiLogs.ts
|
|
630
|
+
src/models/GetResourceSessionScormData.ts
|
|
631
|
+
src/models/GetResourceSessionScormDataActivity.ts
|
|
607
632
|
src/models/GetResourceUsage.ts
|
|
608
633
|
src/models/GetResourceUsageCoursesInner.ts
|
|
609
634
|
src/models/GetResourceVersionUpload.ts
|
|
@@ -721,6 +746,7 @@ src/models/PostResetPassword.ts
|
|
|
721
746
|
src/models/PostResource.ts
|
|
722
747
|
src/models/PostResourceVersion.ts
|
|
723
748
|
src/models/PostResourceVersionComplete.ts
|
|
749
|
+
src/models/PostResourceVersionSession.ts
|
|
724
750
|
src/models/PostResourceVersionUpload.ts
|
|
725
751
|
src/models/PostRevokeCertificate.ts
|
|
726
752
|
src/models/PostRichTextAssetComplete.ts
|
|
@@ -772,6 +798,8 @@ src/models/PutUser.ts
|
|
|
772
798
|
src/models/QuizContent.ts
|
|
773
799
|
src/models/QuizContentAssignment.ts
|
|
774
800
|
src/models/QuizContentSettings.ts
|
|
801
|
+
src/models/ResourceSessionEnvironment.ts
|
|
802
|
+
src/models/ResourceSessionScormApiLogItem.ts
|
|
775
803
|
src/models/ResourceType.ts
|
|
776
804
|
src/models/RichTextAsset.ts
|
|
777
805
|
src/models/RichTextDocument.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
1
|
+
# @easyedu/js-lsm-api@1.91.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
|
|
4
4
|
|
|
@@ -161,6 +161,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
161
161
|
*ContentLibraryApi* | [**postResourceVersion**](docs/ContentLibraryApi.md#postresourceversion) | **POST** /content-library/resources/{resourceId}/versions | Create the next draft resource version
|
|
162
162
|
*ContentLibraryApi* | [**postResourceVersionArchive**](docs/ContentLibraryApi.md#postresourceversionarchive) | **POST** /content-library/resources/{resourceId}/versions/{versionId}/archive | Archive a published resource version
|
|
163
163
|
*ContentLibraryApi* | [**postResourceVersionPublish**](docs/ContentLibraryApi.md#postresourceversionpublish) | **POST** /content-library/resources/{resourceId}/versions/{versionId}/publish | Publish an immutable resource version
|
|
164
|
+
*ContentLibraryApi* | [**postResourceVersionSession**](docs/ContentLibraryApi.md#postresourceversionsession) | **POST** /content-library/resources/{resourceId}/versions/{versionId}/sessions | Start or resume a demo session for an exact resource version
|
|
164
165
|
*ContentLibraryApi* | [**postResourceVersionUpload**](docs/ContentLibraryApi.md#postresourceversionupload) | **POST** /content-library/resources/{resourceId}/versions/{versionId}/upload | Initialize a version-scoped file upload
|
|
165
166
|
*ContentLibraryApi* | [**postResourceVersionUploadComplete**](docs/ContentLibraryApi.md#postresourceversionuploadcomplete) | **POST** /content-library/resources/{resourceId}/versions/{versionId}/upload/complete | Verify and complete a resource upload
|
|
166
167
|
*ContentLibraryApi* | [**putResource**](docs/ContentLibraryApi.md#putresource) | **PUT** /content-library/resources/{resourceId} | Update resource library metadata
|
|
@@ -264,12 +265,19 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
264
265
|
*PlayerApi* | [**getPdfPlayer**](docs/PlayerApi.md#getpdfplayer) | **GET** /pdf/session/{sessionId}/player | PDF player HTML page
|
|
265
266
|
*PlayerApi* | [**getQuizPlayer**](docs/PlayerApi.md#getquizplayer) | **GET** /quiz/session/{sessionId}/player | Quiz player HTML page
|
|
266
267
|
*PlayerApi* | [**getResourceScormValue**](docs/PlayerApi.md#getresourcescormvalue) | **GET** /resource/sessions/{sessionId}/get-value | Read a CMI value from a reusable SCORM resource session
|
|
268
|
+
*PlayerApi* | [**getResourceSession**](docs/PlayerApi.md#getresourcesession) | **GET** /resource/sessions/{sessionId} | Get a resource session
|
|
269
|
+
*PlayerApi* | [**getResourceSessionAsset**](docs/PlayerApi.md#getresourcesessionasset) | **GET** /resource/sessions/{sessionId}/asset/{assetPath} | Stream an asset pinned to a resource session
|
|
270
|
+
*PlayerApi* | [**getResourceSessionDiagnostics**](docs/PlayerApi.md#getresourcesessiondiagnostics) | **GET** /resource/sessions/{sessionId}/diagnostics | Get administrator diagnostics for a resource session
|
|
271
|
+
*PlayerApi* | [**getResourceSessionList**](docs/PlayerApi.md#getresourcesessionlist) | **GET** /resource/sessions | List resource sessions for the selected portal
|
|
267
272
|
*PlayerApi* | [**getResourceSessionPlayer**](docs/PlayerApi.md#getresourcesessionplayer) | **GET** /resource/sessions/{sessionId}/player | Serve the player for a version-pinned reusable resource session
|
|
273
|
+
*PlayerApi* | [**getResourceSessionScormApiLogs**](docs/PlayerApi.md#getresourcesessionscormapilogs) | **GET** /resource/sessions/{sessionId}/api-logs | Get SCORM runtime logs for a resource session
|
|
274
|
+
*PlayerApi* | [**getResourceSessionScormData**](docs/PlayerApi.md#getresourcesessionscormdata) | **GET** /resource/sessions/{sessionId}/scorm-data | Get SCORM CMI data for a resource session
|
|
268
275
|
*PlayerApi* | [**getScormAsset**](docs/PlayerApi.md#getscormasset) | **GET** /scorm/{contentId}/scorm/asset/{assetPath} | SCORM package asset
|
|
269
276
|
*PlayerApi* | [**getScormPlayer**](docs/PlayerApi.md#getscormplayer) | **GET** /scorm/session/{sessionId}/player | SCORM player HTML page
|
|
270
277
|
*PlayerApi* | [**getVideoAsset**](docs/PlayerApi.md#getvideoasset) | **GET** /video/{contentId}/asset | Video asset
|
|
271
278
|
*PlayerApi* | [**getVideoPlayer**](docs/PlayerApi.md#getvideoplayer) | **GET** /video/session/{sessionId}/player | Video player HTML page
|
|
272
279
|
*PlayerApi* | [**initializeResourceScormSession**](docs/PlayerApi.md#initializeresourcescormsession) | **POST** /resource/sessions/{sessionId}/initialize | Initialize a reusable SCORM resource session
|
|
280
|
+
*PlayerApi* | [**postResourceSessionComplete**](docs/PlayerApi.md#postresourcesessioncomplete) | **POST** /resource/sessions/{sessionId}/complete | Complete a non-SCORM resource session
|
|
273
281
|
*PlayerApi* | [**setResourceScormValue**](docs/PlayerApi.md#setresourcescormvalue) | **POST** /resource/sessions/{sessionId}/set-value | Store a CMI value in a reusable SCORM resource session
|
|
274
282
|
*PlayerApi* | [**terminateResourceScormSession**](docs/PlayerApi.md#terminateresourcescormsession) | **POST** /resource/sessions/{sessionId}/terminate | Terminate a reusable SCORM resource session
|
|
275
283
|
*PortalApi* | [**deletePortalFavicon**](docs/PortalApi.md#deleteportalfavicon) | **DELETE** /portals/{portalId}/branding/favicon | Remove the portal favicon
|
|
@@ -562,6 +570,17 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
562
570
|
- [GetQuizStatistics](docs/GetQuizStatistics.md)
|
|
563
571
|
- [GetResource](docs/GetResource.md)
|
|
564
572
|
- [GetResourceList](docs/GetResourceList.md)
|
|
573
|
+
- [GetResourceSession](docs/GetResourceSession.md)
|
|
574
|
+
- [GetResourceSessionDiagnostics](docs/GetResourceSessionDiagnostics.md)
|
|
575
|
+
- [GetResourceSessionDiagnosticsCourseContext](docs/GetResourceSessionDiagnosticsCourseContext.md)
|
|
576
|
+
- [GetResourceSessionDiagnosticsResource](docs/GetResourceSessionDiagnosticsResource.md)
|
|
577
|
+
- [GetResourceSessionDiagnosticsScormSummary](docs/GetResourceSessionDiagnosticsScormSummary.md)
|
|
578
|
+
- [GetResourceSessionDiagnosticsUser](docs/GetResourceSessionDiagnosticsUser.md)
|
|
579
|
+
- [GetResourceSessionDiagnosticsVersion](docs/GetResourceSessionDiagnosticsVersion.md)
|
|
580
|
+
- [GetResourceSessionList](docs/GetResourceSessionList.md)
|
|
581
|
+
- [GetResourceSessionScormApiLogs](docs/GetResourceSessionScormApiLogs.md)
|
|
582
|
+
- [GetResourceSessionScormData](docs/GetResourceSessionScormData.md)
|
|
583
|
+
- [GetResourceSessionScormDataActivity](docs/GetResourceSessionScormDataActivity.md)
|
|
565
584
|
- [GetResourceUsage](docs/GetResourceUsage.md)
|
|
566
585
|
- [GetResourceUsageCoursesInner](docs/GetResourceUsageCoursesInner.md)
|
|
567
586
|
- [GetResourceVersionUpload](docs/GetResourceVersionUpload.md)
|
|
@@ -679,6 +698,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
679
698
|
- [PostResource](docs/PostResource.md)
|
|
680
699
|
- [PostResourceVersion](docs/PostResourceVersion.md)
|
|
681
700
|
- [PostResourceVersionComplete](docs/PostResourceVersionComplete.md)
|
|
701
|
+
- [PostResourceVersionSession](docs/PostResourceVersionSession.md)
|
|
682
702
|
- [PostResourceVersionUpload](docs/PostResourceVersionUpload.md)
|
|
683
703
|
- [PostRevokeCertificate](docs/PostRevokeCertificate.md)
|
|
684
704
|
- [PostRichTextAssetComplete](docs/PostRichTextAssetComplete.md)
|
|
@@ -730,6 +750,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
730
750
|
- [QuizContent](docs/QuizContent.md)
|
|
731
751
|
- [QuizContentAssignment](docs/QuizContentAssignment.md)
|
|
732
752
|
- [QuizContentSettings](docs/QuizContentSettings.md)
|
|
753
|
+
- [ResourceSessionEnvironment](docs/ResourceSessionEnvironment.md)
|
|
754
|
+
- [ResourceSessionScormApiLogItem](docs/ResourceSessionScormApiLogItem.md)
|
|
733
755
|
- [ResourceType](docs/ResourceType.md)
|
|
734
756
|
- [RichTextAsset](docs/RichTextAsset.md)
|
|
735
757
|
- [RichTextDocument](docs/RichTextDocument.md)
|
|
@@ -764,7 +786,7 @@ and is automatically generated by the
|
|
|
764
786
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
765
787
|
|
|
766
788
|
- API version: `1.0.0`
|
|
767
|
-
- Package version: `1.
|
|
789
|
+
- Package version: `1.91.0`
|
|
768
790
|
- Generator version: `7.22.0`
|
|
769
791
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
770
792
|
|
|
@@ -13,11 +13,13 @@ import * as runtime from '../runtime';
|
|
|
13
13
|
import { type GetContentLibraryVersion } from '../models/GetContentLibraryVersion';
|
|
14
14
|
import { type GetResource } from '../models/GetResource';
|
|
15
15
|
import { type GetResourceList } from '../models/GetResourceList';
|
|
16
|
+
import { type GetResourceSession } from '../models/GetResourceSession';
|
|
16
17
|
import { type GetResourceUsage } from '../models/GetResourceUsage';
|
|
17
18
|
import { type GetResourceVersionUpload } from '../models/GetResourceVersionUpload';
|
|
18
19
|
import { type PostResource } from '../models/PostResource';
|
|
19
20
|
import { type PostResourceVersion } from '../models/PostResourceVersion';
|
|
20
21
|
import { type PostResourceVersionComplete } from '../models/PostResourceVersionComplete';
|
|
22
|
+
import { type PostResourceVersionSession } from '../models/PostResourceVersionSession';
|
|
21
23
|
import { type PostResourceVersionUpload } from '../models/PostResourceVersionUpload';
|
|
22
24
|
import { type PutResource } from '../models/PutResource';
|
|
23
25
|
import { type PutResourceVersion } from '../models/PutResourceVersion';
|
|
@@ -67,6 +69,11 @@ export interface PostResourceVersionPublishRequest {
|
|
|
67
69
|
resourceId: string;
|
|
68
70
|
versionId: string;
|
|
69
71
|
}
|
|
72
|
+
export interface PostResourceVersionSessionRequest {
|
|
73
|
+
resourceId: string;
|
|
74
|
+
versionId: string;
|
|
75
|
+
postResourceVersionSession?: PostResourceVersionSession;
|
|
76
|
+
}
|
|
70
77
|
export interface PostResourceVersionUploadRequest {
|
|
71
78
|
resourceId: string;
|
|
72
79
|
versionId: string;
|
|
@@ -227,6 +234,18 @@ export declare class ContentLibraryApi extends runtime.BaseAPI {
|
|
|
227
234
|
* Publish an immutable resource version
|
|
228
235
|
*/
|
|
229
236
|
postResourceVersionPublish(requestParameters: PostResourceVersionPublishRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentLibraryVersion>;
|
|
237
|
+
/**
|
|
238
|
+
* Creates request options for postResourceVersionSession without sending the request
|
|
239
|
+
*/
|
|
240
|
+
postResourceVersionSessionRequestOpts(requestParameters: PostResourceVersionSessionRequest): Promise<runtime.RequestOpts>;
|
|
241
|
+
/**
|
|
242
|
+
* Start or resume a demo session for an exact resource version
|
|
243
|
+
*/
|
|
244
|
+
postResourceVersionSessionRaw(requestParameters: PostResourceVersionSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>>;
|
|
245
|
+
/**
|
|
246
|
+
* Start or resume a demo session for an exact resource version
|
|
247
|
+
*/
|
|
248
|
+
postResourceVersionSession(requestParameters: PostResourceVersionSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
|
|
230
249
|
/**
|
|
231
250
|
* Creates request options for postResourceVersionUpload without sending the request
|
|
232
251
|
*/
|
|
@@ -27,11 +27,13 @@ const runtime = require("../runtime");
|
|
|
27
27
|
const GetContentLibraryVersion_1 = require("../models/GetContentLibraryVersion");
|
|
28
28
|
const GetResource_1 = require("../models/GetResource");
|
|
29
29
|
const GetResourceList_1 = require("../models/GetResourceList");
|
|
30
|
+
const GetResourceSession_1 = require("../models/GetResourceSession");
|
|
30
31
|
const GetResourceUsage_1 = require("../models/GetResourceUsage");
|
|
31
32
|
const GetResourceVersionUpload_1 = require("../models/GetResourceVersionUpload");
|
|
32
33
|
const PostResource_1 = require("../models/PostResource");
|
|
33
34
|
const PostResourceVersion_1 = require("../models/PostResourceVersion");
|
|
34
35
|
const PostResourceVersionComplete_1 = require("../models/PostResourceVersionComplete");
|
|
36
|
+
const PostResourceVersionSession_1 = require("../models/PostResourceVersionSession");
|
|
35
37
|
const PostResourceVersionUpload_1 = require("../models/PostResourceVersionUpload");
|
|
36
38
|
const PutResource_1 = require("../models/PutResource");
|
|
37
39
|
const PutResourceVersion_1 = require("../models/PutResourceVersion");
|
|
@@ -505,6 +507,51 @@ class ContentLibraryApi extends runtime.BaseAPI {
|
|
|
505
507
|
return yield response.value();
|
|
506
508
|
});
|
|
507
509
|
}
|
|
510
|
+
/**
|
|
511
|
+
* Creates request options for postResourceVersionSession without sending the request
|
|
512
|
+
*/
|
|
513
|
+
postResourceVersionSessionRequestOpts(requestParameters) {
|
|
514
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
515
|
+
if (requestParameters['resourceId'] == null) {
|
|
516
|
+
throw new runtime.RequiredError('resourceId', 'Required parameter "resourceId" was null or undefined when calling postResourceVersionSession().');
|
|
517
|
+
}
|
|
518
|
+
if (requestParameters['versionId'] == null) {
|
|
519
|
+
throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling postResourceVersionSession().');
|
|
520
|
+
}
|
|
521
|
+
const queryParameters = {};
|
|
522
|
+
const headerParameters = {};
|
|
523
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
524
|
+
let urlPath = `/content-library/resources/{resourceId}/versions/{versionId}/sessions`;
|
|
525
|
+
urlPath = urlPath.replace('{resourceId}', encodeURIComponent(String(requestParameters['resourceId'])));
|
|
526
|
+
urlPath = urlPath.replace('{versionId}', encodeURIComponent(String(requestParameters['versionId'])));
|
|
527
|
+
return {
|
|
528
|
+
path: urlPath,
|
|
529
|
+
method: 'POST',
|
|
530
|
+
headers: headerParameters,
|
|
531
|
+
query: queryParameters,
|
|
532
|
+
body: (0, PostResourceVersionSession_1.PostResourceVersionSessionToJSON)(requestParameters['postResourceVersionSession']),
|
|
533
|
+
};
|
|
534
|
+
});
|
|
535
|
+
}
|
|
536
|
+
/**
|
|
537
|
+
* Start or resume a demo session for an exact resource version
|
|
538
|
+
*/
|
|
539
|
+
postResourceVersionSessionRaw(requestParameters, initOverrides) {
|
|
540
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
541
|
+
const requestOptions = yield this.postResourceVersionSessionRequestOpts(requestParameters);
|
|
542
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
543
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSession_1.GetResourceSessionFromJSON)(jsonValue));
|
|
544
|
+
});
|
|
545
|
+
}
|
|
546
|
+
/**
|
|
547
|
+
* Start or resume a demo session for an exact resource version
|
|
548
|
+
*/
|
|
549
|
+
postResourceVersionSession(requestParameters, initOverrides) {
|
|
550
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
551
|
+
const response = yield this.postResourceVersionSessionRaw(requestParameters, initOverrides);
|
|
552
|
+
return yield response.value();
|
|
553
|
+
});
|
|
554
|
+
}
|
|
508
555
|
/**
|
|
509
556
|
* Creates request options for postResourceVersionUpload without sending the request
|
|
510
557
|
*/
|
package/dist/apis/PlayerApi.d.ts
CHANGED
|
@@ -10,6 +10,13 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
+
import { type GetResourceSession } from '../models/GetResourceSession';
|
|
14
|
+
import { type GetResourceSessionDiagnostics } from '../models/GetResourceSessionDiagnostics';
|
|
15
|
+
import { type GetResourceSessionList } from '../models/GetResourceSessionList';
|
|
16
|
+
import { type GetResourceSessionScormApiLogs } from '../models/GetResourceSessionScormApiLogs';
|
|
17
|
+
import { type GetResourceSessionScormData } from '../models/GetResourceSessionScormData';
|
|
18
|
+
import { type ResourceSessionEnvironment } from '../models/ResourceSessionEnvironment';
|
|
19
|
+
import { type ResourceType } from '../models/ResourceType';
|
|
13
20
|
import { type ScormGetValueResponse } from '../models/ScormGetValueResponse';
|
|
14
21
|
import { type ScormSetValueRequest } from '../models/ScormSetValueRequest';
|
|
15
22
|
import { type ScormSetValueResponse } from '../models/ScormSetValueResponse';
|
|
@@ -46,9 +53,53 @@ export interface GetResourceScormValueRequest {
|
|
|
46
53
|
sessionId: string;
|
|
47
54
|
key: string;
|
|
48
55
|
}
|
|
56
|
+
export interface GetResourceSessionRequest {
|
|
57
|
+
sessionId: string;
|
|
58
|
+
}
|
|
59
|
+
export interface GetResourceSessionAssetRequest {
|
|
60
|
+
sessionId: string;
|
|
61
|
+
assetPath: string;
|
|
62
|
+
}
|
|
63
|
+
export interface GetResourceSessionDiagnosticsRequest {
|
|
64
|
+
sessionId: string;
|
|
65
|
+
}
|
|
66
|
+
export interface GetResourceSessionListRequest {
|
|
67
|
+
userId?: string;
|
|
68
|
+
resourceId?: string;
|
|
69
|
+
versionId?: string;
|
|
70
|
+
courseId?: string;
|
|
71
|
+
courseVersionId?: string;
|
|
72
|
+
itemId?: string;
|
|
73
|
+
resourceType?: ResourceType;
|
|
74
|
+
environment?: ResourceSessionEnvironment;
|
|
75
|
+
completionStatus?: GetResourceSessionListCompletionStatusEnum;
|
|
76
|
+
gradeStatus?: GetResourceSessionListGradeStatusEnum;
|
|
77
|
+
isCurrent?: boolean;
|
|
78
|
+
attemptNumber?: number;
|
|
79
|
+
createdFrom?: number;
|
|
80
|
+
createdTo?: number;
|
|
81
|
+
updatedFrom?: number;
|
|
82
|
+
updatedTo?: number;
|
|
83
|
+
hasScormErrors?: boolean;
|
|
84
|
+
sortBy?: GetResourceSessionListSortByEnum;
|
|
85
|
+
sortDirection?: GetResourceSessionListSortDirectionEnum;
|
|
86
|
+
page?: number;
|
|
87
|
+
pageSize?: number;
|
|
88
|
+
}
|
|
49
89
|
export interface GetResourceSessionPlayerRequest {
|
|
50
90
|
sessionId: string;
|
|
51
91
|
}
|
|
92
|
+
export interface GetResourceSessionScormApiLogsRequest {
|
|
93
|
+
sessionId: string;
|
|
94
|
+
method?: GetResourceSessionScormApiLogsMethodEnum;
|
|
95
|
+
element?: string;
|
|
96
|
+
errorsOnly?: boolean;
|
|
97
|
+
page?: number;
|
|
98
|
+
pageSize?: number;
|
|
99
|
+
}
|
|
100
|
+
export interface GetResourceSessionScormDataRequest {
|
|
101
|
+
sessionId: string;
|
|
102
|
+
}
|
|
52
103
|
export interface GetScormAssetRequest {
|
|
53
104
|
contentId: string;
|
|
54
105
|
assetPath: string;
|
|
@@ -65,6 +116,9 @@ export interface GetVideoPlayerRequest {
|
|
|
65
116
|
export interface InitializeResourceScormSessionRequest {
|
|
66
117
|
sessionId: string;
|
|
67
118
|
}
|
|
119
|
+
export interface PostResourceSessionCompleteRequest {
|
|
120
|
+
sessionId: string;
|
|
121
|
+
}
|
|
68
122
|
export interface SetResourceScormValueRequest {
|
|
69
123
|
sessionId: string;
|
|
70
124
|
scormSetValueRequest: ScormSetValueRequest;
|
|
@@ -196,6 +250,54 @@ export declare class PlayerApi extends runtime.BaseAPI {
|
|
|
196
250
|
* Read a CMI value from a reusable SCORM resource session
|
|
197
251
|
*/
|
|
198
252
|
getResourceScormValue(requestParameters: GetResourceScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScormGetValueResponse>;
|
|
253
|
+
/**
|
|
254
|
+
* Creates request options for getResourceSession without sending the request
|
|
255
|
+
*/
|
|
256
|
+
getResourceSessionRequestOpts(requestParameters: GetResourceSessionRequest): Promise<runtime.RequestOpts>;
|
|
257
|
+
/**
|
|
258
|
+
* Get a resource session
|
|
259
|
+
*/
|
|
260
|
+
getResourceSessionRaw(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>>;
|
|
261
|
+
/**
|
|
262
|
+
* Get a resource session
|
|
263
|
+
*/
|
|
264
|
+
getResourceSession(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
|
|
265
|
+
/**
|
|
266
|
+
* Creates request options for getResourceSessionAsset without sending the request
|
|
267
|
+
*/
|
|
268
|
+
getResourceSessionAssetRequestOpts(requestParameters: GetResourceSessionAssetRequest): Promise<runtime.RequestOpts>;
|
|
269
|
+
/**
|
|
270
|
+
* Stream an asset pinned to a resource session
|
|
271
|
+
*/
|
|
272
|
+
getResourceSessionAssetRaw(requestParameters: GetResourceSessionAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
|
|
273
|
+
/**
|
|
274
|
+
* Stream an asset pinned to a resource session
|
|
275
|
+
*/
|
|
276
|
+
getResourceSessionAsset(requestParameters: GetResourceSessionAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
277
|
+
/**
|
|
278
|
+
* Creates request options for getResourceSessionDiagnostics without sending the request
|
|
279
|
+
*/
|
|
280
|
+
getResourceSessionDiagnosticsRequestOpts(requestParameters: GetResourceSessionDiagnosticsRequest): Promise<runtime.RequestOpts>;
|
|
281
|
+
/**
|
|
282
|
+
* Get administrator diagnostics for a resource session
|
|
283
|
+
*/
|
|
284
|
+
getResourceSessionDiagnosticsRaw(requestParameters: GetResourceSessionDiagnosticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionDiagnostics>>;
|
|
285
|
+
/**
|
|
286
|
+
* Get administrator diagnostics for a resource session
|
|
287
|
+
*/
|
|
288
|
+
getResourceSessionDiagnostics(requestParameters: GetResourceSessionDiagnosticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionDiagnostics>;
|
|
289
|
+
/**
|
|
290
|
+
* Creates request options for getResourceSessionList without sending the request
|
|
291
|
+
*/
|
|
292
|
+
getResourceSessionListRequestOpts(requestParameters: GetResourceSessionListRequest): Promise<runtime.RequestOpts>;
|
|
293
|
+
/**
|
|
294
|
+
* List resource sessions for the selected portal
|
|
295
|
+
*/
|
|
296
|
+
getResourceSessionListRaw(requestParameters: GetResourceSessionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionList>>;
|
|
297
|
+
/**
|
|
298
|
+
* List resource sessions for the selected portal
|
|
299
|
+
*/
|
|
300
|
+
getResourceSessionList(requestParameters?: GetResourceSessionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionList>;
|
|
199
301
|
/**
|
|
200
302
|
* Creates request options for getResourceSessionPlayer without sending the request
|
|
201
303
|
*/
|
|
@@ -208,6 +310,30 @@ export declare class PlayerApi extends runtime.BaseAPI {
|
|
|
208
310
|
* Serve the player for a version-pinned reusable resource session
|
|
209
311
|
*/
|
|
210
312
|
getResourceSessionPlayer(requestParameters: GetResourceSessionPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
313
|
+
/**
|
|
314
|
+
* Creates request options for getResourceSessionScormApiLogs without sending the request
|
|
315
|
+
*/
|
|
316
|
+
getResourceSessionScormApiLogsRequestOpts(requestParameters: GetResourceSessionScormApiLogsRequest): Promise<runtime.RequestOpts>;
|
|
317
|
+
/**
|
|
318
|
+
* Get SCORM runtime logs for a resource session
|
|
319
|
+
*/
|
|
320
|
+
getResourceSessionScormApiLogsRaw(requestParameters: GetResourceSessionScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionScormApiLogs>>;
|
|
321
|
+
/**
|
|
322
|
+
* Get SCORM runtime logs for a resource session
|
|
323
|
+
*/
|
|
324
|
+
getResourceSessionScormApiLogs(requestParameters: GetResourceSessionScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionScormApiLogs>;
|
|
325
|
+
/**
|
|
326
|
+
* Creates request options for getResourceSessionScormData without sending the request
|
|
327
|
+
*/
|
|
328
|
+
getResourceSessionScormDataRequestOpts(requestParameters: GetResourceSessionScormDataRequest): Promise<runtime.RequestOpts>;
|
|
329
|
+
/**
|
|
330
|
+
* Get SCORM CMI data for a resource session
|
|
331
|
+
*/
|
|
332
|
+
getResourceSessionScormDataRaw(requestParameters: GetResourceSessionScormDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionScormData>>;
|
|
333
|
+
/**
|
|
334
|
+
* Get SCORM CMI data for a resource session
|
|
335
|
+
*/
|
|
336
|
+
getResourceSessionScormData(requestParameters: GetResourceSessionScormDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionScormData>;
|
|
211
337
|
/**
|
|
212
338
|
* Creates request options for getScormAsset without sending the request
|
|
213
339
|
*/
|
|
@@ -268,6 +394,18 @@ export declare class PlayerApi extends runtime.BaseAPI {
|
|
|
268
394
|
* Initialize a reusable SCORM resource session
|
|
269
395
|
*/
|
|
270
396
|
initializeResourceScormSession(requestParameters: InitializeResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
397
|
+
/**
|
|
398
|
+
* Creates request options for postResourceSessionComplete without sending the request
|
|
399
|
+
*/
|
|
400
|
+
postResourceSessionCompleteRequestOpts(requestParameters: PostResourceSessionCompleteRequest): Promise<runtime.RequestOpts>;
|
|
401
|
+
/**
|
|
402
|
+
* Complete a non-SCORM resource session
|
|
403
|
+
*/
|
|
404
|
+
postResourceSessionCompleteRaw(requestParameters: PostResourceSessionCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>>;
|
|
405
|
+
/**
|
|
406
|
+
* Complete a non-SCORM resource session
|
|
407
|
+
*/
|
|
408
|
+
postResourceSessionComplete(requestParameters: PostResourceSessionCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
|
|
271
409
|
/**
|
|
272
410
|
* Creates request options for setResourceScormValue without sending the request
|
|
273
411
|
*/
|
|
@@ -293,3 +431,52 @@ export declare class PlayerApi extends runtime.BaseAPI {
|
|
|
293
431
|
*/
|
|
294
432
|
terminateResourceScormSession(requestParameters: TerminateResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
295
433
|
}
|
|
434
|
+
/**
|
|
435
|
+
* @export
|
|
436
|
+
*/
|
|
437
|
+
export declare const GetResourceSessionListCompletionStatusEnum: {
|
|
438
|
+
readonly NotAttempted: "not_attempted";
|
|
439
|
+
readonly InProgress: "in_progress";
|
|
440
|
+
readonly Completed: "completed";
|
|
441
|
+
};
|
|
442
|
+
export type GetResourceSessionListCompletionStatusEnum = typeof GetResourceSessionListCompletionStatusEnum[keyof typeof GetResourceSessionListCompletionStatusEnum];
|
|
443
|
+
/**
|
|
444
|
+
* @export
|
|
445
|
+
*/
|
|
446
|
+
export declare const GetResourceSessionListGradeStatusEnum: {
|
|
447
|
+
readonly Ungraded: "ungraded";
|
|
448
|
+
readonly Passed: "passed";
|
|
449
|
+
readonly Failed: "failed";
|
|
450
|
+
readonly PointsEarned: "points_earned";
|
|
451
|
+
readonly PercentageEarned: "percentage_earned";
|
|
452
|
+
readonly NotApplicable: "not_applicable";
|
|
453
|
+
};
|
|
454
|
+
export type GetResourceSessionListGradeStatusEnum = typeof GetResourceSessionListGradeStatusEnum[keyof typeof GetResourceSessionListGradeStatusEnum];
|
|
455
|
+
/**
|
|
456
|
+
* @export
|
|
457
|
+
*/
|
|
458
|
+
export declare const GetResourceSessionListSortByEnum: {
|
|
459
|
+
readonly CreatedAt: "created_at";
|
|
460
|
+
readonly UpdatedAt: "updated_at";
|
|
461
|
+
readonly AttemptNumber: "attempt_number";
|
|
462
|
+
};
|
|
463
|
+
export type GetResourceSessionListSortByEnum = typeof GetResourceSessionListSortByEnum[keyof typeof GetResourceSessionListSortByEnum];
|
|
464
|
+
/**
|
|
465
|
+
* @export
|
|
466
|
+
*/
|
|
467
|
+
export declare const GetResourceSessionListSortDirectionEnum: {
|
|
468
|
+
readonly Asc: "asc";
|
|
469
|
+
readonly Desc: "desc";
|
|
470
|
+
};
|
|
471
|
+
export type GetResourceSessionListSortDirectionEnum = typeof GetResourceSessionListSortDirectionEnum[keyof typeof GetResourceSessionListSortDirectionEnum];
|
|
472
|
+
/**
|
|
473
|
+
* @export
|
|
474
|
+
*/
|
|
475
|
+
export declare const GetResourceSessionScormApiLogsMethodEnum: {
|
|
476
|
+
readonly Initialize: "Initialize";
|
|
477
|
+
readonly GetValue: "GetValue";
|
|
478
|
+
readonly SetValue: "SetValue";
|
|
479
|
+
readonly Commit: "Commit";
|
|
480
|
+
readonly Terminate: "Terminate";
|
|
481
|
+
};
|
|
482
|
+
export type GetResourceSessionScormApiLogsMethodEnum = typeof GetResourceSessionScormApiLogsMethodEnum[keyof typeof GetResourceSessionScormApiLogsMethodEnum];
|