@easyedu/js-lsm-api 1.88.0 → 1.90.0

package/docs/GetCourseVersionItemSession.md

@@ -8,6 +8,7 @@ A learner resource attempt pinned to an immutable course and Content Library ver
 Name | Type
 ------------ | -------------
 `id` | string
+`environment` | [ResourceSessionEnvironment](ResourceSessionEnvironment.md)
 `courseVersionId` | string
 `itemId` | string
 `contentLibraryItemId` | string
@@ -32,6 +33,7 @@ import type { GetCourseVersionItemSession } from '@easyedu/js-lsm-api'
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
+  "environment": null,
   "courseVersionId": null,
   "itemId": null,
   "contentLibraryItemId": null,

package/docs/GetResourceSession.md

@@ -0,0 +1,77 @@
+
+# GetResourceSession
+
+A user-owned session pinned to an immutable Content Library resource version.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`userId` | string
+`environment` | [ResourceSessionEnvironment](ResourceSessionEnvironment.md)
+`courseId` | string
+`courseVersionId` | string
+`itemId` | string
+`contentLibraryItemId` | string
+`contentLibraryVersionId` | string
+`resourceName` | string
+`resourceType` | [ResourceType](ResourceType.md)
+`launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
+`launchUrl` | string
+`attemptNumber` | number
+`isCurrent` | boolean
+`completionStatus` | string
+`gradeStatus` | string
+`scoreRaw` | number
+`initializedAt` | number
+`terminatedAt` | number
+`createdAt` | number
+`updatedAt` | number
+`completedAt` | number
+
+## Example
+
+```typescript
+import type { GetResourceSession } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "userId": null,
+  "environment": null,
+  "courseId": null,
+  "courseVersionId": null,
+  "itemId": null,
+  "contentLibraryItemId": null,
+  "contentLibraryVersionId": null,
+  "resourceName": null,
+  "resourceType": null,
+  "launchMode": null,
+  "launchUrl": null,
+  "attemptNumber": null,
+  "isCurrent": null,
+  "completionStatus": null,
+  "gradeStatus": null,
+  "scoreRaw": null,
+  "initializedAt": null,
+  "terminatedAt": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "completedAt": null,
+} satisfies GetResourceSession
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetResourceSession
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetResourceSessionList.md

@@ -0,0 +1,43 @@
+
+# GetResourceSessionList
+
+A filtered page of resource sessions.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<GetResourceSession>](GetResourceSession.md)
+
+## Example
+
+```typescript
+import type { GetResourceSessionList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "pageSize": null,
+  "totalPages": null,
+  "totalItems": null,
+  "items": null,
+} satisfies GetResourceSessionList
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetResourceSessionList
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PlayerApi.md

@@ -14,12 +14,16 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getPdfPlayer**](PlayerApi.md#getpdfplayer) | **GET** /pdf/session/{sessionId}/player | PDF player HTML page |
 | [**getQuizPlayer**](PlayerApi.md#getquizplayer) | **GET** /quiz/session/{sessionId}/player | Quiz player HTML page |
 | [**getResourceScormValue**](PlayerApi.md#getresourcescormvalue) | **GET** /resource/sessions/{sessionId}/get-value | Read a CMI value from a reusable SCORM resource session |
+| [**getResourceSession**](PlayerApi.md#getresourcesession) | **GET** /resource/sessions/{sessionId} | Get a resource session |
+| [**getResourceSessionAsset**](PlayerApi.md#getresourcesessionasset) | **GET** /resource/sessions/{sessionId}/asset/{assetPath} | Stream an asset pinned to a resource session |
+| [**getResourceSessionList**](PlayerApi.md#getresourcesessionlist) | **GET** /resource/sessions | List resource sessions for the selected portal |
 | [**getResourceSessionPlayer**](PlayerApi.md#getresourcesessionplayer) | **GET** /resource/sessions/{sessionId}/player | Serve the player for a version-pinned reusable resource session |
 | [**getScormAsset**](PlayerApi.md#getscormasset) | **GET** /scorm/{contentId}/scorm/asset/{assetPath} | SCORM package asset |
 | [**getScormPlayer**](PlayerApi.md#getscormplayer) | **GET** /scorm/session/{sessionId}/player | SCORM player HTML page |
 | [**getVideoAsset**](PlayerApi.md#getvideoasset) | **GET** /video/{contentId}/asset | Video asset |
 | [**getVideoPlayer**](PlayerApi.md#getvideoplayer) | **GET** /video/session/{sessionId}/player | Video player HTML page |
 | [**initializeResourceScormSession**](PlayerApi.md#initializeresourcescormsession) | **POST** /resource/sessions/{sessionId}/initialize | Initialize a reusable SCORM resource session |
+| [**postResourceSessionComplete**](PlayerApi.md#postresourcesessioncomplete) | **POST** /resource/sessions/{sessionId}/complete | Complete a non-SCORM resource session |
 | [**setResourceScormValue**](PlayerApi.md#setresourcescormvalue) | **POST** /resource/sessions/{sessionId}/set-value | Store a CMI value in a reusable SCORM resource session |
 | [**terminateResourceScormSession**](PlayerApi.md#terminateresourcescormsession) | **POST** /resource/sessions/{sessionId}/terminate | Terminate a reusable SCORM resource session |
 
@@ -700,6 +704,232 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getResourceSession
+
+> GetResourceSession getResourceSession(sessionId)
+
+Get a resource session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { GetResourceSessionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PlayerApi();
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetResourceSessionRequest;
+
+  try {
+    const data = await api.getResourceSession(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetResourceSession**](GetResourceSession.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Resource session |  -  |
+| **404** | Resource session not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getResourceSessionAsset
+
+> Blob getResourceSessionAsset(sessionId, assetPath)
+
+Stream an asset pinned to a resource session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { GetResourceSessionAssetRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PlayerApi();
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    assetPath: assetPath_example,
+  } satisfies GetResourceSessionAssetRequest;
+
+  try {
+    const data = await api.getResourceSessionAsset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` |  | [Defaults to `undefined`] |
+| **assetPath** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/octet-stream`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Resource bytes |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getResourceSessionList
+
+> GetResourceSessionList getResourceSessionList(userId, resourceId, versionId, courseId, environment, completionStatus, createdFrom, createdTo, page, pageSize)
+
+List resource sessions for the selected portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { GetResourceSessionListRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PlayerApi();
+
+  const body = {
+    // string (optional)
+    userId: userId_example,
+    // string (optional)
+    resourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    courseId: courseId_example,
+    // ResourceSessionEnvironment (optional)
+    environment: ...,
+    // string (optional)
+    completionStatus: completionStatus_example,
+    // number (optional)
+    createdFrom: 789,
+    // number (optional)
+    createdTo: 789,
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies GetResourceSessionListRequest;
+
+  try {
+    const data = await api.getResourceSessionList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **resourceId** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **versionId** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **environment** | `ResourceSessionEnvironment` |  | [Optional] [Defaults to `undefined`] [Enum: live, demo] |
+| **completionStatus** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **createdFrom** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **createdTo** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**GetResourceSessionList**](GetResourceSessionList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Resource sessions |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getResourceSessionPlayer
 
 > string getResourceSessionPlayer(sessionId)
@@ -1104,6 +1334,72 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## postResourceSessionComplete
+
+> GetResourceSession postResourceSessionComplete(sessionId)
+
+Complete a non-SCORM resource session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { PostResourceSessionCompleteRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PlayerApi();
+
+  const body = {
+    // string
+    sessionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies PostResourceSessionCompleteRequest;
+
+  try {
+    const data = await api.postResourceSessionComplete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sessionId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetResourceSession**](GetResourceSession.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Completed resource session |  -  |
+| **400** | SCORM sessions complete through their runtime |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## setResourceScormValue
 
 > ScormSetValueResponse setResourceScormValue(sessionId, scormSetValueRequest)

package/docs/PostResourceVersionSession.md

@@ -0,0 +1,35 @@
+
+# PostResourceVersionSession
+
+Start or resume an isolated demo session for an exact resource version.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`restart` | boolean
+
+## Example
+
+```typescript
+import type { PostResourceVersionSession } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "restart": null,
+} satisfies PostResourceVersionSession
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PostResourceVersionSession
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ResourceSessionEnvironment.md

@@ -0,0 +1,33 @@
+
+# ResourceSessionEnvironment
+
+Whether the session contributes to learner activity or is isolated administrator testing.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ResourceSessionEnvironment } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ResourceSessionEnvironment
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ResourceSessionEnvironment
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.88.0",
+  "version": "1.90.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/ContentLibraryApi.ts

@@ -28,6 +28,11 @@ import {
     GetResourceListFromJSON,
     GetResourceListToJSON,
 } from '../models/GetResourceList';
+import {
+    type GetResourceSession,
+    GetResourceSessionFromJSON,
+    GetResourceSessionToJSON,
+} from '../models/GetResourceSession';
 import {
     type GetResourceUsage,
     GetResourceUsageFromJSON,
@@ -53,6 +58,11 @@ import {
     PostResourceVersionCompleteFromJSON,
     PostResourceVersionCompleteToJSON,
 } from '../models/PostResourceVersionComplete';
+import {
+    type PostResourceVersionSession,
+    PostResourceVersionSessionFromJSON,
+    PostResourceVersionSessionToJSON,
+} from '../models/PostResourceVersionSession';
 import {
     type PostResourceVersionUpload,
     PostResourceVersionUploadFromJSON,
@@ -130,6 +140,12 @@ export interface PostResourceVersionPublishRequest {
     versionId: string;
 }
 
+export interface PostResourceVersionSessionRequest {
+    resourceId: string;
+    versionId: string;
+    postResourceVersionSession?: PostResourceVersionSession;
+}
+
 export interface PostResourceVersionUploadRequest {
     resourceId: string;
     versionId: string;
@@ -715,6 +731,62 @@ export class ContentLibraryApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postResourceVersionSession without sending the request
+     */
+    async postResourceVersionSessionRequestOpts(requestParameters: PostResourceVersionSessionRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['resourceId'] == null) {
+            throw new runtime.RequiredError(
+                'resourceId',
+                'Required parameter "resourceId" was null or undefined when calling postResourceVersionSession().'
+            );
+        }
+
+        if (requestParameters['versionId'] == null) {
+            throw new runtime.RequiredError(
+                'versionId',
+                'Required parameter "versionId" was null or undefined when calling postResourceVersionSession().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/content-library/resources/{resourceId}/versions/{versionId}/sessions`;
+        urlPath = urlPath.replace('{resourceId}', encodeURIComponent(String(requestParameters['resourceId'])));
+        urlPath = urlPath.replace('{versionId}', encodeURIComponent(String(requestParameters['versionId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostResourceVersionSessionToJSON(requestParameters['postResourceVersionSession']),
+        };
+    }
+
+    /**
+     * Start or resume a demo session for an exact resource version
+     */
+    async postResourceVersionSessionRaw(requestParameters: PostResourceVersionSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>> {
+        const requestOptions = await this.postResourceVersionSessionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionFromJSON(jsonValue));
+    }
+
+    /**
+     * Start or resume a demo session for an exact resource version
+     */
+    async postResourceVersionSession(requestParameters: PostResourceVersionSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession> {
+        const response = await this.postResourceVersionSessionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postResourceVersionUpload without sending the request
      */