@easyedu/js-lsm-api 1.89.0 → 1.90.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 (50) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +11 -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 +73 -0
  6. package/dist/apis/PlayerApi.js +188 -0
  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 +73 -0
  10. package/dist/esm/apis/PlayerApi.js +188 -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 +161 -0
  14. package/dist/esm/models/GetResourceSession.js +112 -0
  15. package/dist/esm/models/GetResourceSessionList.d.ts +57 -0
  16. package/dist/esm/models/GetResourceSessionList.js +60 -0
  17. package/dist/esm/models/PostResourceVersionSession.d.ts +32 -0
  18. package/dist/esm/models/PostResourceVersionSession.js +41 -0
  19. package/dist/esm/models/ResourceSessionEnvironment.d.ts +25 -0
  20. package/dist/esm/models/ResourceSessionEnvironment.js +43 -0
  21. package/dist/esm/models/index.d.ts +4 -0
  22. package/dist/esm/models/index.js +4 -0
  23. package/dist/models/GetCourseVersionItemSession.d.ts +7 -0
  24. package/dist/models/GetCourseVersionItemSession.js +5 -0
  25. package/dist/models/GetResourceSession.d.ts +161 -0
  26. package/dist/models/GetResourceSession.js +119 -0
  27. package/dist/models/GetResourceSessionList.d.ts +57 -0
  28. package/dist/models/GetResourceSessionList.js +67 -0
  29. package/dist/models/PostResourceVersionSession.d.ts +32 -0
  30. package/dist/models/PostResourceVersionSession.js +48 -0
  31. package/dist/models/ResourceSessionEnvironment.d.ts +25 -0
  32. package/dist/models/ResourceSessionEnvironment.js +51 -0
  33. package/dist/models/index.d.ts +4 -0
  34. package/dist/models/index.js +4 -0
  35. package/docs/ContentLibraryApi.md +73 -0
  36. package/docs/GetCourseVersionItemSession.md +2 -0
  37. package/docs/GetResourceSession.md +77 -0
  38. package/docs/GetResourceSessionList.md +43 -0
  39. package/docs/PlayerApi.md +296 -0
  40. package/docs/PostResourceVersionSession.md +35 -0
  41. package/docs/ResourceSessionEnvironment.md +33 -0
  42. package/package.json +1 -1
  43. package/src/apis/ContentLibraryApi.ts +72 -0
  44. package/src/apis/PlayerApi.ts +261 -0
  45. package/src/models/GetCourseVersionItemSession.ts +16 -0
  46. package/src/models/GetResourceSession.ts +270 -0
  47. package/src/models/GetResourceSessionList.ts +110 -0
  48. package/src/models/PostResourceVersionSession.ts +65 -0
  49. package/src/models/ResourceSessionEnvironment.ts +53 -0
  50. package/src/models/index.ts +4 -0
@@ -194,6 +194,8 @@ docs/GetQuizResultsTiming.md
194
194
  docs/GetQuizStatistics.md
195
195
  docs/GetResource.md
196
196
  docs/GetResourceList.md
197
+ docs/GetResourceSession.md
198
+ docs/GetResourceSessionList.md
197
199
  docs/GetResourceUsage.md
198
200
  docs/GetResourceUsageCoursesInner.md
199
201
  docs/GetResourceVersionUpload.md
@@ -316,6 +318,7 @@ docs/PostResetPassword.md
316
318
  docs/PostResource.md
317
319
  docs/PostResourceVersion.md
318
320
  docs/PostResourceVersionComplete.md
321
+ docs/PostResourceVersionSession.md
319
322
  docs/PostResourceVersionUpload.md
320
323
  docs/PostRevokeCertificate.md
321
324
  docs/PostRichTextAssetComplete.md
@@ -370,6 +373,7 @@ docs/QuizContent.md
370
373
  docs/QuizContentAssignment.md
371
374
  docs/QuizContentSettings.md
372
375
  docs/ReportingApi.md
376
+ docs/ResourceSessionEnvironment.md
373
377
  docs/ResourceType.md
374
378
  docs/RichTextApi.md
375
379
  docs/RichTextAsset.md
@@ -604,6 +608,8 @@ src/models/GetQuizResultsTiming.ts
604
608
  src/models/GetQuizStatistics.ts
605
609
  src/models/GetResource.ts
606
610
  src/models/GetResourceList.ts
611
+ src/models/GetResourceSession.ts
612
+ src/models/GetResourceSessionList.ts
607
613
  src/models/GetResourceUsage.ts
608
614
  src/models/GetResourceUsageCoursesInner.ts
609
615
  src/models/GetResourceVersionUpload.ts
@@ -721,6 +727,7 @@ src/models/PostResetPassword.ts
721
727
  src/models/PostResource.ts
722
728
  src/models/PostResourceVersion.ts
723
729
  src/models/PostResourceVersionComplete.ts
730
+ src/models/PostResourceVersionSession.ts
724
731
  src/models/PostResourceVersionUpload.ts
725
732
  src/models/PostRevokeCertificate.ts
726
733
  src/models/PostRichTextAssetComplete.ts
@@ -772,6 +779,7 @@ src/models/PutUser.ts
772
779
  src/models/QuizContent.ts
773
780
  src/models/QuizContentAssignment.ts
774
781
  src/models/QuizContentSettings.ts
782
+ src/models/ResourceSessionEnvironment.ts
775
783
  src/models/ResourceType.ts
776
784
  src/models/RichTextAsset.ts
777
785
  src/models/RichTextDocument.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @easyedu/js-lsm-api@1.89.0
1
+ # @easyedu/js-lsm-api@1.90.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,16 @@ 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* | [**getResourceSessionList**](docs/PlayerApi.md#getresourcesessionlist) | **GET** /resource/sessions | List resource sessions for the selected portal
267
271
  *PlayerApi* | [**getResourceSessionPlayer**](docs/PlayerApi.md#getresourcesessionplayer) | **GET** /resource/sessions/{sessionId}/player | Serve the player for a version-pinned reusable resource session
268
272
  *PlayerApi* | [**getScormAsset**](docs/PlayerApi.md#getscormasset) | **GET** /scorm/{contentId}/scorm/asset/{assetPath} | SCORM package asset
269
273
  *PlayerApi* | [**getScormPlayer**](docs/PlayerApi.md#getscormplayer) | **GET** /scorm/session/{sessionId}/player | SCORM player HTML page
270
274
  *PlayerApi* | [**getVideoAsset**](docs/PlayerApi.md#getvideoasset) | **GET** /video/{contentId}/asset | Video asset
271
275
  *PlayerApi* | [**getVideoPlayer**](docs/PlayerApi.md#getvideoplayer) | **GET** /video/session/{sessionId}/player | Video player HTML page
272
276
  *PlayerApi* | [**initializeResourceScormSession**](docs/PlayerApi.md#initializeresourcescormsession) | **POST** /resource/sessions/{sessionId}/initialize | Initialize a reusable SCORM resource session
277
+ *PlayerApi* | [**postResourceSessionComplete**](docs/PlayerApi.md#postresourcesessioncomplete) | **POST** /resource/sessions/{sessionId}/complete | Complete a non-SCORM resource session
273
278
  *PlayerApi* | [**setResourceScormValue**](docs/PlayerApi.md#setresourcescormvalue) | **POST** /resource/sessions/{sessionId}/set-value | Store a CMI value in a reusable SCORM resource session
274
279
  *PlayerApi* | [**terminateResourceScormSession**](docs/PlayerApi.md#terminateresourcescormsession) | **POST** /resource/sessions/{sessionId}/terminate | Terminate a reusable SCORM resource session
275
280
  *PortalApi* | [**deletePortalFavicon**](docs/PortalApi.md#deleteportalfavicon) | **DELETE** /portals/{portalId}/branding/favicon | Remove the portal favicon
@@ -562,6 +567,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
562
567
  - [GetQuizStatistics](docs/GetQuizStatistics.md)
563
568
  - [GetResource](docs/GetResource.md)
564
569
  - [GetResourceList](docs/GetResourceList.md)
570
+ - [GetResourceSession](docs/GetResourceSession.md)
571
+ - [GetResourceSessionList](docs/GetResourceSessionList.md)
565
572
  - [GetResourceUsage](docs/GetResourceUsage.md)
566
573
  - [GetResourceUsageCoursesInner](docs/GetResourceUsageCoursesInner.md)
567
574
  - [GetResourceVersionUpload](docs/GetResourceVersionUpload.md)
@@ -679,6 +686,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
679
686
  - [PostResource](docs/PostResource.md)
680
687
  - [PostResourceVersion](docs/PostResourceVersion.md)
681
688
  - [PostResourceVersionComplete](docs/PostResourceVersionComplete.md)
689
+ - [PostResourceVersionSession](docs/PostResourceVersionSession.md)
682
690
  - [PostResourceVersionUpload](docs/PostResourceVersionUpload.md)
683
691
  - [PostRevokeCertificate](docs/PostRevokeCertificate.md)
684
692
  - [PostRichTextAssetComplete](docs/PostRichTextAssetComplete.md)
@@ -730,6 +738,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
730
738
  - [QuizContent](docs/QuizContent.md)
731
739
  - [QuizContentAssignment](docs/QuizContentAssignment.md)
732
740
  - [QuizContentSettings](docs/QuizContentSettings.md)
741
+ - [ResourceSessionEnvironment](docs/ResourceSessionEnvironment.md)
733
742
  - [ResourceType](docs/ResourceType.md)
734
743
  - [RichTextAsset](docs/RichTextAsset.md)
735
744
  - [RichTextDocument](docs/RichTextDocument.md)
@@ -764,7 +773,7 @@ and is automatically generated by the
764
773
  [OpenAPI Generator](https://openapi-generator.tech) project:
765
774
 
766
775
  - API version: `1.0.0`
767
- - Package version: `1.89.0`
776
+ - Package version: `1.90.0`
768
777
  - Generator version: `7.22.0`
769
778
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
770
779
 
@@ -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
  */
@@ -10,6 +10,9 @@
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 GetResourceSessionList } from '../models/GetResourceSessionList';
15
+ import { type ResourceSessionEnvironment } from '../models/ResourceSessionEnvironment';
13
16
  import { type ScormGetValueResponse } from '../models/ScormGetValueResponse';
14
17
  import { type ScormSetValueRequest } from '../models/ScormSetValueRequest';
15
18
  import { type ScormSetValueResponse } from '../models/ScormSetValueResponse';
@@ -46,6 +49,25 @@ export interface GetResourceScormValueRequest {
46
49
  sessionId: string;
47
50
  key: string;
48
51
  }
52
+ export interface GetResourceSessionRequest {
53
+ sessionId: string;
54
+ }
55
+ export interface GetResourceSessionAssetRequest {
56
+ sessionId: string;
57
+ assetPath: string;
58
+ }
59
+ export interface GetResourceSessionListRequest {
60
+ userId?: string;
61
+ resourceId?: string;
62
+ versionId?: string;
63
+ courseId?: string;
64
+ environment?: ResourceSessionEnvironment;
65
+ completionStatus?: string;
66
+ createdFrom?: number;
67
+ createdTo?: number;
68
+ page?: number;
69
+ pageSize?: number;
70
+ }
49
71
  export interface GetResourceSessionPlayerRequest {
50
72
  sessionId: string;
51
73
  }
@@ -65,6 +87,9 @@ export interface GetVideoPlayerRequest {
65
87
  export interface InitializeResourceScormSessionRequest {
66
88
  sessionId: string;
67
89
  }
90
+ export interface PostResourceSessionCompleteRequest {
91
+ sessionId: string;
92
+ }
68
93
  export interface SetResourceScormValueRequest {
69
94
  sessionId: string;
70
95
  scormSetValueRequest: ScormSetValueRequest;
@@ -196,6 +221,42 @@ export declare class PlayerApi extends runtime.BaseAPI {
196
221
  * Read a CMI value from a reusable SCORM resource session
197
222
  */
198
223
  getResourceScormValue(requestParameters: GetResourceScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScormGetValueResponse>;
224
+ /**
225
+ * Creates request options for getResourceSession without sending the request
226
+ */
227
+ getResourceSessionRequestOpts(requestParameters: GetResourceSessionRequest): Promise<runtime.RequestOpts>;
228
+ /**
229
+ * Get a resource session
230
+ */
231
+ getResourceSessionRaw(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>>;
232
+ /**
233
+ * Get a resource session
234
+ */
235
+ getResourceSession(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
236
+ /**
237
+ * Creates request options for getResourceSessionAsset without sending the request
238
+ */
239
+ getResourceSessionAssetRequestOpts(requestParameters: GetResourceSessionAssetRequest): Promise<runtime.RequestOpts>;
240
+ /**
241
+ * Stream an asset pinned to a resource session
242
+ */
243
+ getResourceSessionAssetRaw(requestParameters: GetResourceSessionAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
244
+ /**
245
+ * Stream an asset pinned to a resource session
246
+ */
247
+ getResourceSessionAsset(requestParameters: GetResourceSessionAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
248
+ /**
249
+ * Creates request options for getResourceSessionList without sending the request
250
+ */
251
+ getResourceSessionListRequestOpts(requestParameters: GetResourceSessionListRequest): Promise<runtime.RequestOpts>;
252
+ /**
253
+ * List resource sessions for the selected portal
254
+ */
255
+ getResourceSessionListRaw(requestParameters: GetResourceSessionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionList>>;
256
+ /**
257
+ * List resource sessions for the selected portal
258
+ */
259
+ getResourceSessionList(requestParameters?: GetResourceSessionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionList>;
199
260
  /**
200
261
  * Creates request options for getResourceSessionPlayer without sending the request
201
262
  */
@@ -268,6 +329,18 @@ export declare class PlayerApi extends runtime.BaseAPI {
268
329
  * Initialize a reusable SCORM resource session
269
330
  */
270
331
  initializeResourceScormSession(requestParameters: InitializeResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
332
+ /**
333
+ * Creates request options for postResourceSessionComplete without sending the request
334
+ */
335
+ postResourceSessionCompleteRequestOpts(requestParameters: PostResourceSessionCompleteRequest): Promise<runtime.RequestOpts>;
336
+ /**
337
+ * Complete a non-SCORM resource session
338
+ */
339
+ postResourceSessionCompleteRaw(requestParameters: PostResourceSessionCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>>;
340
+ /**
341
+ * Complete a non-SCORM resource session
342
+ */
343
+ postResourceSessionComplete(requestParameters: PostResourceSessionCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
271
344
  /**
272
345
  * Creates request options for setResourceScormValue without sending the request
273
346
  */
@@ -24,6 +24,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
25
  exports.PlayerApi = void 0;
26
26
  const runtime = require("../runtime");
27
+ const GetResourceSession_1 = require("../models/GetResourceSession");
28
+ const GetResourceSessionList_1 = require("../models/GetResourceSessionList");
27
29
  const ScormGetValueResponse_1 = require("../models/ScormGetValueResponse");
28
30
  const ScormSetValueRequest_1 = require("../models/ScormSetValueRequest");
29
31
  const ScormSetValueResponse_1 = require("../models/ScormSetValueResponse");
@@ -427,6 +429,153 @@ class PlayerApi extends runtime.BaseAPI {
427
429
  return yield response.value();
428
430
  });
429
431
  }
432
+ /**
433
+ * Creates request options for getResourceSession without sending the request
434
+ */
435
+ getResourceSessionRequestOpts(requestParameters) {
436
+ return __awaiter(this, void 0, void 0, function* () {
437
+ if (requestParameters['sessionId'] == null) {
438
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSession().');
439
+ }
440
+ const queryParameters = {};
441
+ const headerParameters = {};
442
+ let urlPath = `/resource/sessions/{sessionId}`;
443
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
444
+ return {
445
+ path: urlPath,
446
+ method: 'GET',
447
+ headers: headerParameters,
448
+ query: queryParameters,
449
+ };
450
+ });
451
+ }
452
+ /**
453
+ * Get a resource session
454
+ */
455
+ getResourceSessionRaw(requestParameters, initOverrides) {
456
+ return __awaiter(this, void 0, void 0, function* () {
457
+ const requestOptions = yield this.getResourceSessionRequestOpts(requestParameters);
458
+ const response = yield this.request(requestOptions, initOverrides);
459
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSession_1.GetResourceSessionFromJSON)(jsonValue));
460
+ });
461
+ }
462
+ /**
463
+ * Get a resource session
464
+ */
465
+ getResourceSession(requestParameters, initOverrides) {
466
+ return __awaiter(this, void 0, void 0, function* () {
467
+ const response = yield this.getResourceSessionRaw(requestParameters, initOverrides);
468
+ return yield response.value();
469
+ });
470
+ }
471
+ /**
472
+ * Creates request options for getResourceSessionAsset without sending the request
473
+ */
474
+ getResourceSessionAssetRequestOpts(requestParameters) {
475
+ return __awaiter(this, void 0, void 0, function* () {
476
+ if (requestParameters['sessionId'] == null) {
477
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionAsset().');
478
+ }
479
+ if (requestParameters['assetPath'] == null) {
480
+ throw new runtime.RequiredError('assetPath', 'Required parameter "assetPath" was null or undefined when calling getResourceSessionAsset().');
481
+ }
482
+ const queryParameters = {};
483
+ const headerParameters = {};
484
+ let urlPath = `/resource/sessions/{sessionId}/asset/{assetPath}`;
485
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
486
+ urlPath = urlPath.replace('{assetPath}', encodeURIComponent(String(requestParameters['assetPath'])));
487
+ return {
488
+ path: urlPath,
489
+ method: 'GET',
490
+ headers: headerParameters,
491
+ query: queryParameters,
492
+ };
493
+ });
494
+ }
495
+ /**
496
+ * Stream an asset pinned to a resource session
497
+ */
498
+ getResourceSessionAssetRaw(requestParameters, initOverrides) {
499
+ return __awaiter(this, void 0, void 0, function* () {
500
+ const requestOptions = yield this.getResourceSessionAssetRequestOpts(requestParameters);
501
+ const response = yield this.request(requestOptions, initOverrides);
502
+ return new runtime.BlobApiResponse(response);
503
+ });
504
+ }
505
+ /**
506
+ * Stream an asset pinned to a resource session
507
+ */
508
+ getResourceSessionAsset(requestParameters, initOverrides) {
509
+ return __awaiter(this, void 0, void 0, function* () {
510
+ const response = yield this.getResourceSessionAssetRaw(requestParameters, initOverrides);
511
+ return yield response.value();
512
+ });
513
+ }
514
+ /**
515
+ * Creates request options for getResourceSessionList without sending the request
516
+ */
517
+ getResourceSessionListRequestOpts(requestParameters) {
518
+ return __awaiter(this, void 0, void 0, function* () {
519
+ const queryParameters = {};
520
+ if (requestParameters['userId'] != null) {
521
+ queryParameters['user_id'] = requestParameters['userId'];
522
+ }
523
+ if (requestParameters['resourceId'] != null) {
524
+ queryParameters['resource_id'] = requestParameters['resourceId'];
525
+ }
526
+ if (requestParameters['versionId'] != null) {
527
+ queryParameters['version_id'] = requestParameters['versionId'];
528
+ }
529
+ if (requestParameters['courseId'] != null) {
530
+ queryParameters['course_id'] = requestParameters['courseId'];
531
+ }
532
+ if (requestParameters['environment'] != null) {
533
+ queryParameters['environment'] = requestParameters['environment'];
534
+ }
535
+ if (requestParameters['completionStatus'] != null) {
536
+ queryParameters['completion_status'] = requestParameters['completionStatus'];
537
+ }
538
+ if (requestParameters['createdFrom'] != null) {
539
+ queryParameters['created_from'] = requestParameters['createdFrom'];
540
+ }
541
+ if (requestParameters['createdTo'] != null) {
542
+ queryParameters['created_to'] = requestParameters['createdTo'];
543
+ }
544
+ if (requestParameters['page'] != null) {
545
+ queryParameters['page'] = requestParameters['page'];
546
+ }
547
+ if (requestParameters['pageSize'] != null) {
548
+ queryParameters['pageSize'] = requestParameters['pageSize'];
549
+ }
550
+ const headerParameters = {};
551
+ let urlPath = `/resource/sessions`;
552
+ return {
553
+ path: urlPath,
554
+ method: 'GET',
555
+ headers: headerParameters,
556
+ query: queryParameters,
557
+ };
558
+ });
559
+ }
560
+ /**
561
+ * List resource sessions for the selected portal
562
+ */
563
+ getResourceSessionListRaw(requestParameters, initOverrides) {
564
+ return __awaiter(this, void 0, void 0, function* () {
565
+ const requestOptions = yield this.getResourceSessionListRequestOpts(requestParameters);
566
+ const response = yield this.request(requestOptions, initOverrides);
567
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSessionList_1.GetResourceSessionListFromJSON)(jsonValue));
568
+ });
569
+ }
570
+ /**
571
+ * List resource sessions for the selected portal
572
+ */
573
+ getResourceSessionList() {
574
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
575
+ const response = yield this.getResourceSessionListRaw(requestParameters, initOverrides);
576
+ return yield response.value();
577
+ });
578
+ }
430
579
  /**
431
580
  * Creates request options for getResourceSessionPlayer without sending the request
432
581
  */
@@ -665,6 +814,45 @@ class PlayerApi extends runtime.BaseAPI {
665
814
  yield this.initializeResourceScormSessionRaw(requestParameters, initOverrides);
666
815
  });
667
816
  }
817
+ /**
818
+ * Creates request options for postResourceSessionComplete without sending the request
819
+ */
820
+ postResourceSessionCompleteRequestOpts(requestParameters) {
821
+ return __awaiter(this, void 0, void 0, function* () {
822
+ if (requestParameters['sessionId'] == null) {
823
+ throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling postResourceSessionComplete().');
824
+ }
825
+ const queryParameters = {};
826
+ const headerParameters = {};
827
+ let urlPath = `/resource/sessions/{sessionId}/complete`;
828
+ urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
829
+ return {
830
+ path: urlPath,
831
+ method: 'POST',
832
+ headers: headerParameters,
833
+ query: queryParameters,
834
+ };
835
+ });
836
+ }
837
+ /**
838
+ * Complete a non-SCORM resource session
839
+ */
840
+ postResourceSessionCompleteRaw(requestParameters, initOverrides) {
841
+ return __awaiter(this, void 0, void 0, function* () {
842
+ const requestOptions = yield this.postResourceSessionCompleteRequestOpts(requestParameters);
843
+ const response = yield this.request(requestOptions, initOverrides);
844
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSession_1.GetResourceSessionFromJSON)(jsonValue));
845
+ });
846
+ }
847
+ /**
848
+ * Complete a non-SCORM resource session
849
+ */
850
+ postResourceSessionComplete(requestParameters, initOverrides) {
851
+ return __awaiter(this, void 0, void 0, function* () {
852
+ const response = yield this.postResourceSessionCompleteRaw(requestParameters, initOverrides);
853
+ return yield response.value();
854
+ });
855
+ }
668
856
  /**
669
857
  * Creates request options for setResourceScormValue without sending the request
670
858
  */
@@ -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
  */
@@ -24,11 +24,13 @@ import * as runtime from '../runtime';
24
24
  import { GetContentLibraryVersionFromJSON, } from '../models/GetContentLibraryVersion';
25
25
  import { GetResourceFromJSON, } from '../models/GetResource';
26
26
  import { GetResourceListFromJSON, } from '../models/GetResourceList';
27
+ import { GetResourceSessionFromJSON, } from '../models/GetResourceSession';
27
28
  import { GetResourceUsageFromJSON, } from '../models/GetResourceUsage';
28
29
  import { GetResourceVersionUploadFromJSON, } from '../models/GetResourceVersionUpload';
29
30
  import { PostResourceToJSON, } from '../models/PostResource';
30
31
  import { PostResourceVersionToJSON, } from '../models/PostResourceVersion';
31
32
  import { PostResourceVersionCompleteToJSON, } from '../models/PostResourceVersionComplete';
33
+ import { PostResourceVersionSessionToJSON, } from '../models/PostResourceVersionSession';
32
34
  import { PostResourceVersionUploadToJSON, } from '../models/PostResourceVersionUpload';
33
35
  import { PutResourceToJSON, } from '../models/PutResource';
34
36
  import { PutResourceVersionToJSON, } from '../models/PutResourceVersion';
@@ -502,6 +504,51 @@ export class ContentLibraryApi extends runtime.BaseAPI {
502
504
  return yield response.value();
503
505
  });
504
506
  }
507
+ /**
508
+ * Creates request options for postResourceVersionSession without sending the request
509
+ */
510
+ postResourceVersionSessionRequestOpts(requestParameters) {
511
+ return __awaiter(this, void 0, void 0, function* () {
512
+ if (requestParameters['resourceId'] == null) {
513
+ throw new runtime.RequiredError('resourceId', 'Required parameter "resourceId" was null or undefined when calling postResourceVersionSession().');
514
+ }
515
+ if (requestParameters['versionId'] == null) {
516
+ throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling postResourceVersionSession().');
517
+ }
518
+ const queryParameters = {};
519
+ const headerParameters = {};
520
+ headerParameters['Content-Type'] = 'application/json';
521
+ let urlPath = `/content-library/resources/{resourceId}/versions/{versionId}/sessions`;
522
+ urlPath = urlPath.replace('{resourceId}', encodeURIComponent(String(requestParameters['resourceId'])));
523
+ urlPath = urlPath.replace('{versionId}', encodeURIComponent(String(requestParameters['versionId'])));
524
+ return {
525
+ path: urlPath,
526
+ method: 'POST',
527
+ headers: headerParameters,
528
+ query: queryParameters,
529
+ body: PostResourceVersionSessionToJSON(requestParameters['postResourceVersionSession']),
530
+ };
531
+ });
532
+ }
533
+ /**
534
+ * Start or resume a demo session for an exact resource version
535
+ */
536
+ postResourceVersionSessionRaw(requestParameters, initOverrides) {
537
+ return __awaiter(this, void 0, void 0, function* () {
538
+ const requestOptions = yield this.postResourceVersionSessionRequestOpts(requestParameters);
539
+ const response = yield this.request(requestOptions, initOverrides);
540
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionFromJSON(jsonValue));
541
+ });
542
+ }
543
+ /**
544
+ * Start or resume a demo session for an exact resource version
545
+ */
546
+ postResourceVersionSession(requestParameters, initOverrides) {
547
+ return __awaiter(this, void 0, void 0, function* () {
548
+ const response = yield this.postResourceVersionSessionRaw(requestParameters, initOverrides);
549
+ return yield response.value();
550
+ });
551
+ }
505
552
  /**
506
553
  * Creates request options for postResourceVersionUpload without sending the request
507
554
  */