@easyedu/js-lsm-api 1.89.0 → 1.90.0

package/dist/models/GetResourceSessionList.d.ts

@@ -0,0 +1,57 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { GetResourceSession } from './GetResourceSession';
+/**
+ * A filtered page of resource sessions.
+ * @export
+ * @interface GetResourceSessionList
+ */
+export interface GetResourceSessionList {
+    /**
+     *
+     * @type {number}
+     * @memberof GetResourceSessionList
+     */
+    page: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResourceSessionList
+     */
+    pageSize: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResourceSessionList
+     */
+    totalPages: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetResourceSessionList
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<GetResourceSession>}
+     * @memberof GetResourceSessionList
+     */
+    items: Array<GetResourceSession>;
+}
+/**
+ * Check if a given object implements the GetResourceSessionList interface.
+ */
+export declare function instanceOfGetResourceSessionList(value: object): value is GetResourceSessionList;
+export declare function GetResourceSessionListFromJSON(json: any): GetResourceSessionList;
+export declare function GetResourceSessionListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSessionList;
+export declare function GetResourceSessionListToJSON(json: any): GetResourceSessionList;
+export declare function GetResourceSessionListToJSONTyped(value?: GetResourceSessionList | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetResourceSessionList.js

@@ -0,0 +1,67 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetResourceSessionList = instanceOfGetResourceSessionList;
+exports.GetResourceSessionListFromJSON = GetResourceSessionListFromJSON;
+exports.GetResourceSessionListFromJSONTyped = GetResourceSessionListFromJSONTyped;
+exports.GetResourceSessionListToJSON = GetResourceSessionListToJSON;
+exports.GetResourceSessionListToJSONTyped = GetResourceSessionListToJSONTyped;
+const GetResourceSession_1 = require("./GetResourceSession");
+/**
+ * Check if a given object implements the GetResourceSessionList interface.
+ */
+function instanceOfGetResourceSessionList(value) {
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined)
+        return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined)
+        return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+function GetResourceSessionListFromJSON(json) {
+    return GetResourceSessionListFromJSONTyped(json, false);
+}
+function GetResourceSessionListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': (json['items'].map(GetResourceSession_1.GetResourceSessionFromJSON)),
+    };
+}
+function GetResourceSessionListToJSON(json) {
+    return GetResourceSessionListToJSONTyped(json, false);
+}
+function GetResourceSessionListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': (value['items'].map(GetResourceSession_1.GetResourceSessionToJSON)),
+    };
+}

package/dist/models/PostResourceVersionSession.d.ts

@@ -0,0 +1,32 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Start or resume an isolated demo session for an exact resource version.
+ * @export
+ * @interface PostResourceVersionSession
+ */
+export interface PostResourceVersionSession {
+    /**
+     * Create a clean demo attempt instead of resuming the current demo session.
+     * @type {boolean}
+     * @memberof PostResourceVersionSession
+     */
+    restart?: boolean;
+}
+/**
+ * Check if a given object implements the PostResourceVersionSession interface.
+ */
+export declare function instanceOfPostResourceVersionSession(value: object): value is PostResourceVersionSession;
+export declare function PostResourceVersionSessionFromJSON(json: any): PostResourceVersionSession;
+export declare function PostResourceVersionSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostResourceVersionSession;
+export declare function PostResourceVersionSessionToJSON(json: any): PostResourceVersionSession;
+export declare function PostResourceVersionSessionToJSONTyped(value?: PostResourceVersionSession | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostResourceVersionSession.js

@@ -0,0 +1,48 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPostResourceVersionSession = instanceOfPostResourceVersionSession;
+exports.PostResourceVersionSessionFromJSON = PostResourceVersionSessionFromJSON;
+exports.PostResourceVersionSessionFromJSONTyped = PostResourceVersionSessionFromJSONTyped;
+exports.PostResourceVersionSessionToJSON = PostResourceVersionSessionToJSON;
+exports.PostResourceVersionSessionToJSONTyped = PostResourceVersionSessionToJSONTyped;
+/**
+ * Check if a given object implements the PostResourceVersionSession interface.
+ */
+function instanceOfPostResourceVersionSession(value) {
+    return true;
+}
+function PostResourceVersionSessionFromJSON(json) {
+    return PostResourceVersionSessionFromJSONTyped(json, false);
+}
+function PostResourceVersionSessionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'restart': json['restart'] == null ? undefined : json['restart'],
+    };
+}
+function PostResourceVersionSessionToJSON(json) {
+    return PostResourceVersionSessionToJSONTyped(json, false);
+}
+function PostResourceVersionSessionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'restart': value['restart'],
+    };
+}

package/dist/models/ResourceSessionEnvironment.d.ts

@@ -0,0 +1,25 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Whether the session contributes to learner activity or is isolated administrator testing.
+ * @export
+ */
+export declare const ResourceSessionEnvironment: {
+    readonly Live: "live";
+    readonly Demo: "demo";
+};
+export type ResourceSessionEnvironment = typeof ResourceSessionEnvironment[keyof typeof ResourceSessionEnvironment];
+export declare function instanceOfResourceSessionEnvironment(value: any): boolean;
+export declare function ResourceSessionEnvironmentFromJSON(json: any): ResourceSessionEnvironment;
+export declare function ResourceSessionEnvironmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourceSessionEnvironment;
+export declare function ResourceSessionEnvironmentToJSON(value?: ResourceSessionEnvironment | null): any;
+export declare function ResourceSessionEnvironmentToJSONTyped(value: any, ignoreDiscriminator: boolean): ResourceSessionEnvironment;

package/dist/models/ResourceSessionEnvironment.js

@@ -0,0 +1,51 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceSessionEnvironment = void 0;
+exports.instanceOfResourceSessionEnvironment = instanceOfResourceSessionEnvironment;
+exports.ResourceSessionEnvironmentFromJSON = ResourceSessionEnvironmentFromJSON;
+exports.ResourceSessionEnvironmentFromJSONTyped = ResourceSessionEnvironmentFromJSONTyped;
+exports.ResourceSessionEnvironmentToJSON = ResourceSessionEnvironmentToJSON;
+exports.ResourceSessionEnvironmentToJSONTyped = ResourceSessionEnvironmentToJSONTyped;
+/**
+ * Whether the session contributes to learner activity or is isolated administrator testing.
+ * @export
+ */
+exports.ResourceSessionEnvironment = {
+    Live: 'live',
+    Demo: 'demo'
+};
+function instanceOfResourceSessionEnvironment(value) {
+    for (const key in exports.ResourceSessionEnvironment) {
+        if (Object.prototype.hasOwnProperty.call(exports.ResourceSessionEnvironment, key)) {
+            if (exports.ResourceSessionEnvironment[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function ResourceSessionEnvironmentFromJSON(json) {
+    return ResourceSessionEnvironmentFromJSONTyped(json, false);
+}
+function ResourceSessionEnvironmentFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function ResourceSessionEnvironmentToJSON(value) {
+    return value;
+}
+function ResourceSessionEnvironmentToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/index.d.ts

@@ -180,6 +180,8 @@ export * from './GetQuizResultsTiming';
 export * from './GetQuizStatistics';
 export * from './GetResource';
 export * from './GetResourceList';
+export * from './GetResourceSession';
+export * from './GetResourceSessionList';
 export * from './GetResourceUsage';
 export * from './GetResourceUsageCoursesInner';
 export * from './GetResourceVersionUpload';
@@ -297,6 +299,7 @@ export * from './PostResetPassword';
 export * from './PostResource';
 export * from './PostResourceVersion';
 export * from './PostResourceVersionComplete';
+export * from './PostResourceVersionSession';
 export * from './PostResourceVersionUpload';
 export * from './PostRevokeCertificate';
 export * from './PostRichTextAssetComplete';
@@ -348,6 +351,7 @@ export * from './PutUser';
 export * from './QuizContent';
 export * from './QuizContentAssignment';
 export * from './QuizContentSettings';
+export * from './ResourceSessionEnvironment';
 export * from './ResourceType';
 export * from './RichTextAsset';
 export * from './RichTextDocument';

package/dist/models/index.js

@@ -198,6 +198,8 @@ __exportStar(require("./GetQuizResultsTiming"), exports);
 __exportStar(require("./GetQuizStatistics"), exports);
 __exportStar(require("./GetResource"), exports);
 __exportStar(require("./GetResourceList"), exports);
+__exportStar(require("./GetResourceSession"), exports);
+__exportStar(require("./GetResourceSessionList"), exports);
 __exportStar(require("./GetResourceUsage"), exports);
 __exportStar(require("./GetResourceUsageCoursesInner"), exports);
 __exportStar(require("./GetResourceVersionUpload"), exports);
@@ -315,6 +317,7 @@ __exportStar(require("./PostResetPassword"), exports);
 __exportStar(require("./PostResource"), exports);
 __exportStar(require("./PostResourceVersion"), exports);
 __exportStar(require("./PostResourceVersionComplete"), exports);
+__exportStar(require("./PostResourceVersionSession"), exports);
 __exportStar(require("./PostResourceVersionUpload"), exports);
 __exportStar(require("./PostRevokeCertificate"), exports);
 __exportStar(require("./PostRichTextAssetComplete"), exports);
@@ -366,6 +369,7 @@ __exportStar(require("./PutUser"), exports);
 __exportStar(require("./QuizContent"), exports);
 __exportStar(require("./QuizContentAssignment"), exports);
 __exportStar(require("./QuizContentSettings"), exports);
+__exportStar(require("./ResourceSessionEnvironment"), exports);
 __exportStar(require("./ResourceType"), exports);
 __exportStar(require("./RichTextAsset"), exports);
 __exportStar(require("./RichTextDocument"), exports);

package/docs/ContentLibraryApi.md

@@ -15,6 +15,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**postResourceVersion**](ContentLibraryApi.md#postresourceversion) | **POST** /content-library/resources/{resourceId}/versions | Create the next draft resource version |
 | [**postResourceVersionArchive**](ContentLibraryApi.md#postresourceversionarchive) | **POST** /content-library/resources/{resourceId}/versions/{versionId}/archive | Archive a published resource version |
 | [**postResourceVersionPublish**](ContentLibraryApi.md#postresourceversionpublish) | **POST** /content-library/resources/{resourceId}/versions/{versionId}/publish | Publish an immutable resource version |
+| [**postResourceVersionSession**](ContentLibraryApi.md#postresourceversionsession) | **POST** /content-library/resources/{resourceId}/versions/{versionId}/sessions | Start or resume a demo session for an exact resource version |
 | [**postResourceVersionUpload**](ContentLibraryApi.md#postresourceversionupload) | **POST** /content-library/resources/{resourceId}/versions/{versionId}/upload | Initialize a version-scoped file upload |
 | [**postResourceVersionUploadComplete**](ContentLibraryApi.md#postresourceversionuploadcomplete) | **POST** /content-library/resources/{resourceId}/versions/{versionId}/upload/complete | Verify and complete a resource upload |
 | [**putResource**](ContentLibraryApi.md#putresource) | **PUT** /content-library/resources/{resourceId} | Update resource library metadata |
@@ -778,6 +779,78 @@ 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)
 
 
+## postResourceVersionSession
+
+> GetResourceSession postResourceVersionSession(resourceId, versionId, postResourceVersionSession)
+
+Start or resume a demo session for an exact resource version
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentLibraryApi,
+} from '@easyedu/js-lsm-api';
+import type { PostResourceVersionSessionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentLibraryApi();
+
+  const body = {
+    // string
+    resourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PostResourceVersionSession (optional)
+    postResourceVersionSession: ...,
+  } satisfies PostResourceVersionSessionRequest;
+
+  try {
+    const data = await api.postResourceVersionSession(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **resourceId** | `string` |  | [Defaults to `undefined`] |
+| **versionId** | `string` |  | [Defaults to `undefined`] |
+| **postResourceVersionSession** | [PostResourceVersionSession](PostResourceVersionSession.md) |  | [Optional] |
+
+### Return type
+
+[**GetResourceSession**](GetResourceSession.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Current or newly restarted demo session |  -  |
+| **404** | Resource version 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)
+
+
 ## postResourceVersionUpload
 
 > GetResourceVersionUpload postResourceVersionUpload(resourceId, versionId, postResourceVersionUpload)

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)
+
+