@easyedu/js-lsm-api 1.98.0 → 1.100.0

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.98.0",
+  "version": "1.100.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

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
      */

package/src/apis/CourseApi.ts

@@ -13,6 +13,11 @@
  */
 
 import * as runtime from '../runtime';
+import {
+    type GetAttemptAllowance,
+    GetAttemptAllowanceFromJSON,
+    GetAttemptAllowanceToJSON,
+} from '../models/GetAttemptAllowance';
 import {
     type GetCourse,
     GetCourseFromJSON,
@@ -78,6 +83,16 @@ import {
     GetCourseVersionSectionFromJSON,
     GetCourseVersionSectionToJSON,
 } from '../models/GetCourseVersionSection';
+import {
+    type PostClearSessions,
+    PostClearSessionsFromJSON,
+    PostClearSessionsToJSON,
+} from '../models/PostClearSessions';
+import {
+    type PostClearSessionsResponse,
+    PostClearSessionsResponseFromJSON,
+    PostClearSessionsResponseToJSON,
+} from '../models/PostClearSessionsResponse';
 import {
     type PostCourse,
     PostCourseFromJSON,
@@ -133,6 +148,11 @@ import {
     PostDuplicateFromJSON,
     PostDuplicateToJSON,
 } from '../models/PostDuplicate';
+import {
+    type PutAttemptAllowance,
+    PutAttemptAllowanceFromJSON,
+    PutAttemptAllowanceToJSON,
+} from '../models/PutAttemptAllowance';
 import {
     type PutCourse,
     PutCourseFromJSON,
@@ -226,6 +246,13 @@ export interface GetCourseExportsRequest {
     pageSize?: number;
 }
 
+export interface GetCourseItemLearnerAttemptAllowanceRequest {
+    courseId: string;
+    courseVersionId: string;
+    itemId: string;
+    userId: string;
+}
+
 export interface GetCourseListRequest {
     page?: number;
     pageSize?: number;
@@ -282,6 +309,14 @@ export interface PostCourseImageUploadRequest {
     file: Blob;
 }
 
+export interface PostCourseItemLearnerSessionsClearRequest {
+    courseId: string;
+    courseVersionId: string;
+    itemId: string;
+    userId: string;
+    postClearSessions: PostClearSessions;
+}
+
 export interface PostCourseResumeRequest {
     courseId: string;
 }
@@ -327,6 +362,14 @@ export interface PutCourseEnrollmentRequest {
     putCourseEnrollment: PutCourseEnrollment;
 }
 
+export interface PutCourseItemLearnerAttemptAllowanceRequest {
+    courseId: string;
+    courseVersionId: string;
+    itemId: string;
+    userId: string;
+    putAttemptAllowance: PutAttemptAllowance;
+}
+
 export interface PutCourseVersionItemRequest {
     courseId: string;
     sectionId: string;
@@ -1023,6 +1066,75 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getCourseItemLearnerAttemptAllowance without sending the request
+     */
+    async getCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters: GetCourseItemLearnerAttemptAllowanceRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        if (requestParameters['courseVersionId'] == null) {
+            throw new runtime.RequiredError(
+                'courseVersionId',
+                'Required parameter "courseVersionId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        if (requestParameters['itemId'] == null) {
+            throw new runtime.RequiredError(
+                'itemId',
+                'Required parameter "itemId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
+        urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
+        urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get a learner\'s effective attempt limit for a course item
+     */
+    async getCourseItemLearnerAttemptAllowanceRaw(requestParameters: GetCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttemptAllowance>> {
+        const requestOptions = await this.getCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetAttemptAllowanceFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a learner\'s effective attempt limit for a course item
+     */
+    async getCourseItemLearnerAttemptAllowance(requestParameters: GetCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttemptAllowance> {
+        const response = await this.getCourseItemLearnerAttemptAllowanceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getCourseList without sending the request
      */
@@ -1614,6 +1726,85 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postCourseItemLearnerSessionsClear without sending the request
+     */
+    async postCourseItemLearnerSessionsClearRequestOpts(requestParameters: PostCourseItemLearnerSessionsClearRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling postCourseItemLearnerSessionsClear().'
+            );
+        }
+
+        if (requestParameters['courseVersionId'] == null) {
+            throw new runtime.RequiredError(
+                'courseVersionId',
+                'Required parameter "courseVersionId" was null or undefined when calling postCourseItemLearnerSessionsClear().'
+            );
+        }
+
+        if (requestParameters['itemId'] == null) {
+            throw new runtime.RequiredError(
+                'itemId',
+                'Required parameter "itemId" was null or undefined when calling postCourseItemLearnerSessionsClear().'
+            );
+        }
+
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling postCourseItemLearnerSessionsClear().'
+            );
+        }
+
+        if (requestParameters['postClearSessions'] == null) {
+            throw new runtime.RequiredError(
+                'postClearSessions',
+                'Required parameter "postClearSessions" was null or undefined when calling postCourseItemLearnerSessionsClear().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/sessions/clear`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
+        urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
+        urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostClearSessionsToJSON(requestParameters['postClearSessions']),
+        };
+    }
+
+    /**
+     * Clear all live sessions for a learner and course item
+     */
+    async postCourseItemLearnerSessionsClearRaw(requestParameters: PostCourseItemLearnerSessionsClearRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostClearSessionsResponse>> {
+        const requestOptions = await this.postCourseItemLearnerSessionsClearRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostClearSessionsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Clear all live sessions for a learner and course item
+     */
+    async postCourseItemLearnerSessionsClear(requestParameters: PostCourseItemLearnerSessionsClearRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostClearSessionsResponse> {
+        const response = await this.postCourseItemLearnerSessionsClearRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postCourseResume without sending the request
      */
@@ -2080,6 +2271,85 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for putCourseItemLearnerAttemptAllowance without sending the request
+     */
+    async putCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters: PutCourseItemLearnerAttemptAllowanceRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        if (requestParameters['courseVersionId'] == null) {
+            throw new runtime.RequiredError(
+                'courseVersionId',
+                'Required parameter "courseVersionId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        if (requestParameters['itemId'] == null) {
+            throw new runtime.RequiredError(
+                'itemId',
+                'Required parameter "itemId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        if (requestParameters['putAttemptAllowance'] == null) {
+            throw new runtime.RequiredError(
+                'putAttemptAllowance',
+                'Required parameter "putAttemptAllowance" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
+        urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
+        urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutAttemptAllowanceToJSON(requestParameters['putAttemptAllowance']),
+        };
+    }
+
+    /**
+     * Set extra attempts for a learner on a course item
+     */
+    async putCourseItemLearnerAttemptAllowanceRaw(requestParameters: PutCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttemptAllowance>> {
+        const requestOptions = await this.putCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetAttemptAllowanceFromJSON(jsonValue));
+    }
+
+    /**
+     * Set extra attempts for a learner on a course item
+     */
+    async putCourseItemLearnerAttemptAllowance(requestParameters: PutCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttemptAllowance> {
+        const response = await this.putCourseItemLearnerAttemptAllowanceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for putCourseVersionItem without sending the request
      */