@easyedu/js-lsm-api 1.89.0 → 1.91.0

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/docs/ResourceSessionScormApiLogItem.md

@@ -0,0 +1,47 @@
+
+# ResourceSessionScormApiLogItem
+
+A recorded SCORM runtime call for a resource session.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`createdAt` | number
+`method` | string
+`element` | string
+`value` | string
+`valueTruncated` | boolean
+`errorCode` | string
+
+## Example
+
+```typescript
+import type { ResourceSessionScormApiLogItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "createdAt": null,
+  "method": null,
+  "element": null,
+  "value": null,
+  "valueTruncated": null,
+  "errorCode": null,
+} satisfies ResourceSessionScormApiLogItem
+
+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 ResourceSessionScormApiLogItem
+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.89.0",
+  "version": "1.91.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
      */