@easyedu/js-lsm-api 1.99.0 → 1.101.0

package/docs/GetAttemptAllowance.md

@@ -0,0 +1,51 @@
+
+# GetAttemptAllowance
+
+The effective attempt limit for one learner and course-version item.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`courseId` | string
+`courseVersionId` | string
+`itemId` | string
+`userId` | string
+`baseMaxAttempts` | number
+`additionalAttempts` | number
+`effectiveMaxAttempts` | number
+`attemptsUsed` | number
+`attemptsRemaining` | number
+
+## Example
+
+```typescript
+import type { GetAttemptAllowance } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "courseId": null,
+  "courseVersionId": null,
+  "itemId": null,
+  "userId": null,
+  "baseMaxAttempts": null,
+  "additionalAttempts": null,
+  "effectiveMaxAttempts": null,
+  "attemptsUsed": null,
+  "attemptsRemaining": null,
+} satisfies GetAttemptAllowance
+
+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 GetAttemptAllowance
+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/GetChangelogEntry.md

@@ -0,0 +1,39 @@
+
+# GetChangelogEntry
+
+A user-facing summary of product changes published on one date.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`title` | string
+`desc` | string
+`date` | Date
+
+## Example
+
+```typescript
+import type { GetChangelogEntry } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "title": null,
+  "desc": null,
+  "date": null,
+} satisfies GetChangelogEntry
+
+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 GetChangelogEntry
+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/GetChangelogList.md

@@ -0,0 +1,34 @@
+
+# GetChangelogList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<GetChangelogEntry>](GetChangelogEntry.md)
+
+## Example
+
+```typescript
+import type { GetChangelogList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+} satisfies GetChangelogList
+
+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 GetChangelogList
+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

@@ -20,6 +20,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**initializeResourceScormSession**](PlayerApi.md#initializeresourcescormsession) | **POST** /resource/sessions/{sessionId}/initialize | Initialize a reusable SCORM resource session |
 | [**postResourceSessionActivityEvent**](PlayerApi.md#postresourcesessionactivityevent) | **POST** /resource/sessions/{sessionId}/activities/{activityId}/events | Record learner activity and update active time |
 | [**postResourceSessionComplete**](PlayerApi.md#postresourcesessioncomplete) | **POST** /resource/sessions/{sessionId}/complete | Complete a non-SCORM resource session |
+| [**putResourceSessionOverride**](PlayerApi.md#putresourcesessionoverride) | **PUT** /resource/sessions/{sessionId}/override | Override a learner\'s live resource-session progress |
 | [**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 |
 
@@ -1184,6 +1185,76 @@ 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)
 
 
+## putResourceSessionOverride
+
+> GetResourceSession putResourceSessionOverride(sessionId, putResourceSessionOverride)
+
+Override a learner\'s live resource-session progress
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlayerApi,
+} from '@easyedu/js-lsm-api';
+import type { PutResourceSessionOverrideRequest } 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,
+    // PutResourceSessionOverride
+    putResourceSessionOverride: ...,
+  } satisfies PutResourceSessionOverrideRequest;
+
+  try {
+    const data = await api.putResourceSessionOverride(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`] |
+| **putResourceSessionOverride** | [PutResourceSessionOverride](PutResourceSessionOverride.md) |  | |
+
+### 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** | Updated resource session |  -  |
+| **400** | Invalid override values |  -  |
+| **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)
+
+
 ## setResourceScormValue
 
 > ScormSetValueResponse setResourceScormValue(sessionId, scormSetValueRequest, activityId)

package/docs/PostClearSessions.md

@@ -0,0 +1,34 @@
+
+# PostClearSessions
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`reason` | string
+
+## Example
+
+```typescript
+import type { PostClearSessions } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "reason": null,
+} satisfies PostClearSessions
+
+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 PostClearSessions
+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/PostClearSessionsResponse.md

@@ -0,0 +1,38 @@
+
+# PostClearSessionsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`resourceSessionsDeleted` | number
+`quizSessionsDeleted` | number
+`totalSessionsDeleted` | number
+
+## Example
+
+```typescript
+import type { PostClearSessionsResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "resourceSessionsDeleted": null,
+  "quizSessionsDeleted": null,
+  "totalSessionsDeleted": null,
+} satisfies PostClearSessionsResponse
+
+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 PostClearSessionsResponse
+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/PutAttemptAllowance.md

@@ -0,0 +1,36 @@
+
+# PutAttemptAllowance
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`additionalAttempts` | number
+`reason` | string
+
+## Example
+
+```typescript
+import type { PutAttemptAllowance } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "additionalAttempts": null,
+  "reason": null,
+} satisfies PutAttemptAllowance
+
+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 PutAttemptAllowance
+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/PutLibraryQuizSessionOverride.md

@@ -0,0 +1,41 @@
+
+# PutLibraryQuizSessionOverride
+
+Instructor-entered progress values for an existing live quiz session.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`scorePercentage` | number
+`passed` | boolean
+`reason` | string
+
+## Example
+
+```typescript
+import type { PutLibraryQuizSessionOverride } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "scorePercentage": null,
+  "passed": null,
+  "reason": null,
+} satisfies PutLibraryQuizSessionOverride
+
+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 PutLibraryQuizSessionOverride
+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/PutResourceSessionOverride.md

@@ -0,0 +1,41 @@
+
+# PutResourceSessionOverride
+
+Instructor-entered progress values for an existing live resource session.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`completionStatus` | string
+`gradeStatus` | string
+`scoreRaw` | number
+`reason` | string
+
+## Example
+
+```typescript
+import type { PutResourceSessionOverride } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "completionStatus": null,
+  "gradeStatus": null,
+  "scoreRaw": null,
+  "reason": null,
+} satisfies PutResourceSessionOverride
+
+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 PutResourceSessionOverride
+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.99.0",
+  "version": "1.101.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/ChangelogApi.ts

@@ -0,0 +1,66 @@
+/* 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.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type GetChangelogList,
+    GetChangelogListFromJSON,
+    GetChangelogListToJSON,
+} from '../models/GetChangelogList';
+
+/**
+ * 
+ */
+export class ChangelogApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getChangelog without sending the request
+     */
+    async getChangelogRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/changelog`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns the changelog loaded from the server\'s configured changelog file at startup, newest first.
+     * List user-facing product updates
+     */
+    async getChangelogRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetChangelogList>> {
+        const requestOptions = await this.getChangelogRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetChangelogListFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the changelog loaded from the server\'s configured changelog file at startup, newest first.
+     * List user-facing product updates
+     */
+    async getChangelog(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChangelogList> {
+        const response = await this.getChangelogRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/ContentLibraryQuizApi.ts

@@ -113,6 +113,11 @@ import {
     PutLibraryQuizSessionGradeFromJSON,
     PutLibraryQuizSessionGradeToJSON,
 } from '../models/PutLibraryQuizSessionGrade';
+import {
+    type PutLibraryQuizSessionOverride,
+    PutLibraryQuizSessionOverrideFromJSON,
+    PutLibraryQuizSessionOverrideToJSON,
+} from '../models/PutLibraryQuizSessionOverride';
 import {
     type PutLibraryQuizVersion,
     PutLibraryQuizVersionFromJSON,
@@ -262,6 +267,11 @@ export interface PutLibraryQuizSessionGradeRequest {
     putLibraryQuizSessionGrade: PutLibraryQuizSessionGrade;
 }
 
+export interface PutLibraryQuizSessionOverrideRequest {
+    sessionId: string;
+    putLibraryQuizSessionOverride: PutLibraryQuizSessionOverride;
+}
+
 export interface PutLibraryQuizVersionRequest {
     quizId: string;
     versionId: string;
@@ -1632,6 +1642,61 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for putLibraryQuizSessionOverride without sending the request
+     */
+    async putLibraryQuizSessionOverrideRequestOpts(requestParameters: PutLibraryQuizSessionOverrideRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling putLibraryQuizSessionOverride().'
+            );
+        }
+
+        if (requestParameters['putLibraryQuizSessionOverride'] == null) {
+            throw new runtime.RequiredError(
+                'putLibraryQuizSessionOverride',
+                'Required parameter "putLibraryQuizSessionOverride" was null or undefined when calling putLibraryQuizSessionOverride().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/quiz/sessions/{sessionId}/override`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutLibraryQuizSessionOverrideToJSON(requestParameters['putLibraryQuizSessionOverride']),
+        };
+    }
+
+    /**
+     * Override a learner\'s live quiz-session progress
+     */
+    async putLibraryQuizSessionOverrideRaw(requestParameters: PutLibraryQuizSessionOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLibraryQuizSession>> {
+        const requestOptions = await this.putLibraryQuizSessionOverrideRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetLibraryQuizSessionFromJSON(jsonValue));
+    }
+
+    /**
+     * Override a learner\'s live quiz-session progress
+     */
+    async putLibraryQuizSessionOverride(requestParameters: PutLibraryQuizSessionOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLibraryQuizSession> {
+        const response = await this.putLibraryQuizSessionOverrideRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for putLibraryQuizVersion without sending the request
      */