@easyedu/js-lsm-api 1.67.0 → 1.68.0

package/dist/models/GetContentSessionListItem.js

@@ -32,6 +32,14 @@ function instanceOfGetContentSessionListItem(value) {
         return false;
     if (!('contentId' in value) || value['contentId'] === undefined)
         return false;
+    if (!('completionStatus' in value) || value['completionStatus'] === undefined)
+        return false;
+    if (!('gradeStatus' in value) || value['gradeStatus'] === undefined)
+        return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined)
+        return false;
+    if (!('isCurrent' in value) || value['isCurrent'] === undefined)
+        return false;
     if (!('userData' in value) || value['userData'] === undefined)
         return false;
     if (!('scormSessionData' in value) || value['scormSessionData'] === undefined)
@@ -50,6 +58,10 @@ function GetContentSessionListItemFromJSONTyped(json, ignoreDiscriminator) {
         'createdAt': json['created_at'],
         'updatedAt': json['updated_at'],
         'contentId': json['content_id'],
+        'completionStatus': json['completion_status'],
+        'gradeStatus': json['grade_status'],
+        'attemptNumber': json['attempt_number'],
+        'isCurrent': json['is_current'],
         'userData': (0, GetContentSessionDetailUserData_1.GetContentSessionDetailUserDataFromJSON)(json['user_data']),
         'scormSessionData': (0, GetContentSessionListItemScormSessionData_1.GetContentSessionListItemScormSessionDataFromJSON)(json['scorm_session_data']),
     };
@@ -66,6 +78,10 @@ function GetContentSessionListItemToJSONTyped(value, ignoreDiscriminator = false
         'created_at': value['createdAt'],
         'updated_at': value['updatedAt'],
         'content_id': value['contentId'],
+        'completion_status': value['completionStatus'],
+        'grade_status': value['gradeStatus'],
+        'attempt_number': value['attemptNumber'],
+        'is_current': value['isCurrent'],
         'user_data': (0, GetContentSessionDetailUserData_1.GetContentSessionDetailUserDataToJSON)(value['userData']),
         'scorm_session_data': (0, GetContentSessionListItemScormSessionData_1.GetContentSessionListItemScormSessionDataToJSON)(value['scormSessionData']),
     };

package/dist/models/PostContentSession.d.ts

@@ -52,6 +52,18 @@ export interface PostContentSession {
      * @memberof PostContentSession
      */
     playerSessionId?: string | null;
+    /**
+     * The learner attempt number for this content session
+     * @type {number}
+     * @memberof PostContentSession
+     */
+    attemptNumber: number;
+    /**
+     * Whether this is the current attempt used for learner progress display
+     * @type {boolean}
+     * @memberof PostContentSession
+     */
+    isCurrent: boolean;
 }
 /**
  * Check if a given object implements the PostContentSession interface.

package/dist/models/PostContentSession.js

@@ -33,6 +33,10 @@ function instanceOfPostContentSession(value) {
         return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined)
+        return false;
+    if (!('isCurrent' in value) || value['isCurrent'] === undefined)
+        return false;
     return true;
 }
 function PostContentSessionFromJSON(json) {
@@ -49,6 +53,8 @@ function PostContentSessionFromJSONTyped(json, ignoreDiscriminator) {
         'launchMode': (0, ContentLaunchMode_1.ContentLaunchModeFromJSON)(json['launch_mode']),
         'createdAt': json['created_at'],
         'playerSessionId': json['player_session_id'] == null ? undefined : json['player_session_id'],
+        'attemptNumber': json['attempt_number'],
+        'isCurrent': json['is_current'],
     };
 }
 function PostContentSessionToJSON(json) {
@@ -65,5 +71,7 @@ function PostContentSessionToJSONTyped(value, ignoreDiscriminator = false) {
         'launch_mode': (0, ContentLaunchMode_1.ContentLaunchModeToJSON)(value['launchMode']),
         'created_at': value['createdAt'],
         'player_session_id': value['playerSessionId'],
+        'attempt_number': value['attemptNumber'],
+        'is_current': value['isCurrent'],
     };
 }

package/dist/models/index.d.ts

@@ -1,6 +1,9 @@
 export * from './Certificate';
 export * from './CertificateConfig';
 export * from './CertificatePublic';
+export * from './ContentAttemptItem';
+export * from './ContentAttemptRollupScore';
+export * from './ContentAttemptScore';
 export * from './ContentLaunchMode';
 export * from './CourseCatalog';
 export * from './CourseShare';
@@ -16,6 +19,7 @@ export * from './GetCertificateConfigList';
 export * from './GetCertificateList';
 export * from './GetChatMessage';
 export * from './GetContent';
+export * from './GetContentAttempts';
 export * from './GetContentContentData';
 export * from './GetContentGradeDetail';
 export * from './GetContentGrades';

package/dist/models/index.js

@@ -19,6 +19,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Certificate"), exports);
 __exportStar(require("./CertificateConfig"), exports);
 __exportStar(require("./CertificatePublic"), exports);
+__exportStar(require("./ContentAttemptItem"), exports);
+__exportStar(require("./ContentAttemptRollupScore"), exports);
+__exportStar(require("./ContentAttemptScore"), exports);
 __exportStar(require("./ContentLaunchMode"), exports);
 __exportStar(require("./CourseCatalog"), exports);
 __exportStar(require("./CourseShare"), exports);
@@ -34,6 +37,7 @@ __exportStar(require("./GetCertificateConfigList"), exports);
 __exportStar(require("./GetCertificateList"), exports);
 __exportStar(require("./GetChatMessage"), exports);
 __exportStar(require("./GetContent"), exports);
+__exportStar(require("./GetContentAttempts"), exports);
 __exportStar(require("./GetContentContentData"), exports);
 __exportStar(require("./GetContentGradeDetail"), exports);
 __exportStar(require("./GetContentGrades"), exports);

package/docs/ContentApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**deleteContent**](ContentApi.md#deletecontent) | **DELETE** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | Delete content by id |
 | [**deleteContentVersion**](ContentApi.md#deletecontentversion) | **DELETE** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/versions/{versionId} | Delete an inactive content version |
 | [**getContent**](ContentApi.md#getcontent) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | get content |
+| [**getContentAttempts**](ContentApi.md#getcontentattempts) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/attempts | Get content attempts |
 | [**getContentList**](ContentApi.md#getcontentlist) | **GET** /courses/{courseId}/modules/{moduleId}/contents | get content list |
 | [**getContentSession**](ContentApi.md#getcontentsession) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | get content session |
 | [**getContentSessionDetail**](ContentApi.md#getcontentsessiondetail) | **GET** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/sessions/{sessionId} | Get content session details (instructor only) |
@@ -23,6 +24,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**postContentProcess**](ContentApi.md#postcontentprocess) | **POST** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/process | Post a new content process |
 | [**postContentQuiz**](ContentApi.md#postcontentquiz) | **POST** /courses/{courseId}/modules/{moduleId}/contents/quiz | Create a new quiz content |
 | [**postContentSession**](ContentApi.md#postcontentsession) | **POST** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session | Post a new content session |
+| [**postContentSessionRetake**](ContentApi.md#postcontentsessionretake) | **POST** /courses/{courseId}/modules/{moduleId}/contents/{contentId}/session/retake | Create a new retake content session |
 | [**postContentUpload**](ContentApi.md#postcontentupload) | **POST** /courses/{courseId}/modules/{moduleId}/contents/upload | Post a new content upload |
 | [**putContent**](ContentApi.md#putcontent) | **PUT** /courses/{courseId}/modules/{moduleId}/contents/{contentId} | Update content by id |
 | [**putContentReorder**](ContentApi.md#putcontentreorder) | **PUT** /courses/{courseId}/modules/{moduleId}/contents/reorder | Reorder content in a module |
@@ -327,6 +329,88 @@ 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)
 
 
+## getContentAttempts
+
+> GetContentAttempts getContentAttempts(contentId, moduleId, courseId, userId, environment)
+
+Get content attempts
+
+Lists content attempts and score rollup for the current learner. Instructors may pass user_id to inspect another learner.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { GetContentAttemptsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    contentId: contentId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+    // number | Internal user ID to inspect. Defaults to the authenticated user. (optional)
+    userId: 56,
+    // 'sandbox' | 'live' | Environment type for the attempts list (defaults to live) (optional)
+    environment: environment_example,
+  } satisfies GetContentAttemptsRequest;
+
+  try {
+    const data = await api.getContentAttempts(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contentId** | `string` |  | [Defaults to `undefined`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **userId** | `number` | Internal user ID to inspect. Defaults to the authenticated user. | [Optional] [Defaults to `undefined`] |
+| **environment** | `sandbox`, `live` | Environment type for the attempts list (defaults to live) | [Optional] [Defaults to `'live'`] [Enum: sandbox, live] |
+
+### Return type
+
+[**GetContentAttempts**](GetContentAttempts.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Content attempts response OK |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Content 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)
+
+
 ## getContentList
 
 > GetContentList getContentList(moduleId, courseId)
@@ -1442,6 +1526,81 @@ 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)
 
 
+## postContentSessionRetake
+
+> PostContentSession postContentSessionRetake(contentId, moduleId, courseId, environment)
+
+Create a new retake content session
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ContentApi,
+} from '@easyedu/js-lsm-api';
+import type { PostContentSessionRetakeRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ContentApi();
+
+  const body = {
+    // string
+    contentId: contentId_example,
+    // string
+    moduleId: moduleId_example,
+    // string
+    courseId: courseId_example,
+    // 'sandbox' | 'live' | Environment type for the session (defaults to live) (optional)
+    environment: environment_example,
+  } satisfies PostContentSessionRetakeRequest;
+
+  try {
+    const data = await api.postContentSessionRetake(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **contentId** | `string` |  | [Defaults to `undefined`] |
+| **moduleId** | `string` |  | [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **environment** | `sandbox`, `live` | Environment type for the session (defaults to live) | [Optional] [Defaults to `'live'`] [Enum: sandbox, live] |
+
+### Return type
+
+[**PostContentSession**](PostContentSession.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | post retake session response OK |  -  |
+| **409** | Maximum attempts reached for this content |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## postContentUpload
 
 > GetContentUpload postContentUpload(moduleId, courseId, postContentUpload)

package/docs/ContentAttemptItem.md

@@ -0,0 +1,47 @@
+
+# ContentAttemptItem
+
+A single learner attempt for a content item
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sessionId` | string
+`attemptNumber` | number
+`completionStatus` | string
+`gradeStatus` | string
+`score` | [ContentAttemptScore](ContentAttemptScore.md)
+`createdAt` | number
+`updatedAt` | number
+
+## Example
+
+```typescript
+import type { ContentAttemptItem } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sessionId": null,
+  "attemptNumber": null,
+  "completionStatus": null,
+  "gradeStatus": null,
+  "score": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies ContentAttemptItem
+
+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 ContentAttemptItem
+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/ContentAttemptRollupScore.md

@@ -0,0 +1,37 @@
+
+# ContentAttemptRollupScore
+
+Rolled-up score for a content item
+
+## Properties
+
+Name | Type
+------------ | -------------
+`percentage` | number
+`sourceAttemptNumber` | number
+
+## Example
+
+```typescript
+import type { ContentAttemptRollupScore } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "percentage": null,
+  "sourceAttemptNumber": null,
+} satisfies ContentAttemptRollupScore
+
+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 ContentAttemptRollupScore
+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/ContentAttemptScore.md

@@ -0,0 +1,41 @@
+
+# ContentAttemptScore
+
+Normalized score data for a content attempt
+
+## Properties
+
+Name | Type
+------------ | -------------
+`raw` | number
+`min` | number
+`max` | number
+`percentage` | number
+
+## Example
+
+```typescript
+import type { ContentAttemptScore } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "raw": null,
+  "min": null,
+  "max": null,
+  "percentage": null,
+} satisfies ContentAttemptScore
+
+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 ContentAttemptScore
+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/GetContentAttempts.md

@@ -0,0 +1,51 @@
+
+# GetContentAttempts
+
+Learner attempt history and rollup for a content item
+
+## Properties
+
+Name | Type
+------------ | -------------
+`contentId` | string
+`userId` | string
+`maxAttempts` | number
+`attemptsUsed` | number
+`attemptsRemaining` | number
+`canStartNewAttempt` | boolean
+`scoreRollupStrategy` | string
+`rollupScore` | [ContentAttemptRollupScore](ContentAttemptRollupScore.md)
+`attempts` | [Array<ContentAttemptItem>](ContentAttemptItem.md)
+
+## Example
+
+```typescript
+import type { GetContentAttempts } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "contentId": null,
+  "userId": null,
+  "maxAttempts": null,
+  "attemptsUsed": null,
+  "attemptsRemaining": null,
+  "canStartNewAttempt": null,
+  "scoreRollupStrategy": null,
+  "rollupScore": null,
+  "attempts": null,
+} satisfies GetContentAttempts
+
+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 GetContentAttempts
+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/GetContentSession.md

@@ -13,6 +13,8 @@ Name | Type
 `updatedAt` | number
 `completionStatus` | string
 `gradeStatus` | string
+`attemptNumber` | number
+`isCurrent` | boolean
 
 ## Example
 
@@ -27,6 +29,8 @@ const example = {
   "updatedAt": null,
   "completionStatus": null,
   "gradeStatus": null,
+  "attemptNumber": null,
+  "isCurrent": null,
 } satisfies GetContentSession
 
 console.log(example)

package/docs/GetContentSessionDetail.md

@@ -14,6 +14,8 @@ Name | Type
 `completionStatus` | string
 `gradeStatus` | string
 `durationInSeconds` | number
+`attemptNumber` | number
+`isCurrent` | boolean
 `userData` | [GetContentSessionDetailUserData](GetContentSessionDetailUserData.md)
 `scormSessionData` | [Array<GetContentSessionDetailScormSessionDataInner>](GetContentSessionDetailScormSessionDataInner.md)
 
@@ -31,6 +33,8 @@ const example = {
   "completionStatus": null,
   "gradeStatus": null,
   "durationInSeconds": null,
+  "attemptNumber": null,
+  "isCurrent": null,
   "userData": null,
   "scormSessionData": null,
 } satisfies GetContentSessionDetail

package/docs/GetContentSessionListItem.md

@@ -11,6 +11,10 @@ Name | Type
 `createdAt` | number
 `updatedAt` | number
 `contentId` | string
+`completionStatus` | string
+`gradeStatus` | string
+`attemptNumber` | number
+`isCurrent` | boolean
 `userData` | [GetContentSessionDetailUserData](GetContentSessionDetailUserData.md)
 `scormSessionData` | [GetContentSessionListItemScormSessionData](GetContentSessionListItemScormSessionData.md)
 
@@ -25,6 +29,10 @@ const example = {
   "createdAt": null,
   "updatedAt": null,
   "contentId": null,
+  "completionStatus": null,
+  "gradeStatus": null,
+  "attemptNumber": null,
+  "isCurrent": null,
   "userData": null,
   "scormSessionData": null,
 } satisfies GetContentSessionListItem

package/docs/PostContentSession.md

@@ -13,6 +13,8 @@ Name | Type
 `launchMode` | [ContentLaunchMode](ContentLaunchMode.md)
 `createdAt` | number
 `playerSessionId` | string
+`attemptNumber` | number
+`isCurrent` | boolean
 
 ## Example
 
@@ -27,6 +29,8 @@ const example = {
   "launchMode": null,
   "createdAt": null,
   "playerSessionId": null,
+  "attemptNumber": null,
+  "isCurrent": null,
 } satisfies PostContentSession
 
 console.log(example)

package/package.json

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